Skip to Content
Series

End a series

Stop creating new occurrences. The series is kept with `status: ended`. Future occurrences nobody has RSVPed to are removed; occurrences with RSVPs stay, so cancel those one by one to tell their guests. Requires the `events:write` scope.

DELETE
/v1/series/{id}

Stop creating new occurrences. The series is kept with status: ended. Future occurrences nobody has RSVPed to are removed; occurrences with RSVPs stay, so cancel those one by one to tell their guests.

Requires the events:write scope.

Authorization

secretKey
headerAuthorizationBearer <token>

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

Path Parameters

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

Response Body

The ended series.

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 DELETE 'https://api.whocoming.com/v1/series/string'
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"}