Skip to Content
Series

Create a recurring series

Create a weekly, every-two-weeks or monthly series. Occurrences are created as events about 90 days ahead. Free allows one active series (`plan_limit`). Accepts `Idempotency-Key`. Requires the `events:write` scope.

POST
/v1/series

Create a weekly, every-two-weeks or monthly series. Occurrences are created as events about 90 days ahead. Free allows one active series (plan_limit). Accepts Idempotency-Key.

Requires the events:write scope.

Authorization

secretKey
headerAuthorizationBearer <token>

A secret key: wc_live_... or wc_test_.... Keep it on your server.

Header Parameters

idempotency-key?string

Send a unique value (a UUID works) to make retries safe. A replay within 24 hours returns the first response; the same key with a different body is a 409 idempotency_conflict.

Length1 <= length <= 255

Request Body

application/json
  1. body
title*string
Length1 <= length <= 200
recurrence*||
timezone*string

IANA timezone name.

Length1 <= length <= 64
starts_on*string

First possible date. Occurrences start on or after it.

Formatdate
start_time*string

Wall-clock start time in the series timezone, 24-hour HH:MM.

Match^([01]\d|2[0-3]):[0-5]\d$
duration_minutes*integer
Range1 <= value <= 10080
ends_on?|

Last possible date. Omit for no end.

Formatdate
template?

Event settings copied onto every occurrence. Same rules as on events.

Response Body

The series was created.

application/json
  1. response

A recurring event. Occurrences are created as events about 90 days ahead.

id*string
Match^ser_[0-9A-Za-z]{6,64}$
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
title*string
recurrence*||
rrule*string

The stored RRULE, for reference. Read-only.

timezone*string
starts_on*string
Formatdate
start_time*string

Wall-clock start time in the series timezone, 24-hour HH:MM.

Match^([01]\d|2[0-3]):[0-5]\d$
duration_minutes*integer
ends_on*|
Formatdate
template*

Event settings copied onto every occurrence.

status*string
Value in"active""ended"
created_at*string

ISO 8601 with a UTC offset.

Formatdate-time
Example Request
curl -X POST 'https://api.whocoming.com/v1/series' \  -H 'Content-Type: application/json' \  -d '{  "title": "string",  "recurrence": {    "frequency": "weekly",    "weekday": "monday"  },  "timezone": "string",  "starts_on": "2019-08-24",  "start_time": "string",  "duration_minutes": 1}'
Example Response
{  "id": "string",  "mode": "live",  "title": "string",  "recurrence": {    "frequency": "weekly",    "weekday": "monday"  },  "rrule": "string",  "timezone": "string",  "starts_on": "2019-08-24",  "start_time": "string",  "duration_minutes": 0,  "ends_on": "2019-08-24",  "template": {    "description": "string",    "location_name": "string",    "location_address": "string",    "online_url": "string",    "capacity": 0,    "max_guests": 0,    "waitlist_enabled": true,    "visibility": "public",    "price_note": "string",    "cover_image_url": "string",    "fields": [      {        "key": "string",        "label": "string",        "type": "text",        "required": true,        "options": [          "string"        ]      }    ]  },  "status": "active",  "created_at": "2019-08-24T14:15:22Z"}