Update an event
Change the fields you send. Set `status` to `cancelled` to cancel the event and notify guests. Requires the `events:write` scope.
Change the fields you send. Set status to cancelled to cancel the event and notify guests.
Requires the events:write scope.
secretKeyAuthorizationBearer <token>A secret key: wc_live_... or wc_test_.... Keep it on your server.
id*string^evt_[0-9A-Za-z]{6,64}$application/json- body
Only the fields you send are changed.
title?string1 <= length <= 200starts_at?stringISO 8601. The offset is optional: without one, the time is read in the event's timezone.
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d{1,9})?)?(?:Z|[+-]\d{2}:?\d{2})?$ends_at?|ISO 8601. The offset is optional: without one, the time is read in the event's timezone.
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d{1,9})?)?(?:Z|[+-]\d{2}:?\d{2})?$timezone?stringIANA timezone name.
1 <= length <= 64slug?string^[a-z0-9]+(?:-[a-z0-9]+)*$1 <= length <= 100status?stringSet cancelled to cancel the event and notify its guests.
"draft""published""cancelled"description?|length <= 10000location_name?|length <= 200location_address?|length <= 500online_url?|Link for an online event. https:// only.
^https:\/\/urilength <= 2048capacity?|Seats. null means no limit.
1 <= value <= 1000000max_guests?integerExtra guests (plus-ones) each RSVP may bring.
0 <= value <= 100waitlist_enabled?booleanvisibility?stringpublic events are listed and indexed. unlisted events work by link and embed but are not listed. private events are only visible through this API and the dashboard.
"public""unlisted""private"price_note?|length <= 200cover_image_url?|Image shown on the hosted page and in search results. https:// only.
^https:\/\/urilength <= 2048fields?array<>Custom questions, in display order. At most 100, or fewer on your plan. Each key must be unique.
items <= 100The updated event.
application/json- response
id*string^evt_[0-9A-Za-z]{6,64}$mode*stringlive or test. Always the mode of the API key that made the request.
"live""test"series_id*|Set when the event is an occurrence of a series.
slug*stringtitle*stringdescription*string|nullstarts_at*stringISO 8601 with a UTC offset.
date-timeends_at*|ISO 8601 with a UTC offset.
date-timetimezone*stringlocation_name*string|nulllocation_address*string|nullonline_url*string|nullcapacity*integer|nullmax_guests*integerwaitlist_enabled*booleanvisibility*stringpublic events are listed and indexed. unlisted events work by link and embed but are not listed. private events are only visible through this API and the dashboard.
"public""unlisted""private"status*string"draft""published""cancelled"price_note*string|nullcover_image_url*string|nullfields*array<>counts*url*stringHosted event page.
created_at*stringISO 8601 with a UTC offset.
date-timeupdated_at*stringISO 8601 with a UTC offset.
date-timecurl -X PATCH 'https://api.whocoming.com/v1/events/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "mode": "live", "series_id": "string", "slug": "string", "title": "string", "description": "string", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "timezone": "string", "location_name": "string", "location_address": "string", "online_url": "string", "capacity": 0, "max_guests": 0, "waitlist_enabled": true, "visibility": "public", "status": "draft", "price_note": "string", "cover_image_url": "string", "fields": [ { "key": "string", "label": "string", "type": "text", "required": true, "options": [ "string" ] } ], "counts": { "going": 0, "waitlisted": 0, "spots_left": 0 }, "url": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}