Participation Status

Description #

Changes the status of a user’s participation in an event.

In order for this to be possible, you must request the change_participation_status scope when requesting authorization to access the user’s calendars.

URL format #

{data_center_url}/v1/calendars/{calendar_id}/events/{event_uid}/participation_status

Example Request #

POST /v1/calendars/{calendar_id}/events/{event_uid}/participation_status HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json; charset=utf-8

{
    "status": "accepted"
}

Example Response #

HTTP/1.1 202 Accepted

Request parameters #

calendar_id required  #

The calendar_id of the calendar that contains the event for which you’d like to update the participation status. This ID can be retrieved using a list calendars request

This calendar must not have a calendar_readonly value that is true.

event_uid required  #

The String that uniquely identifies the event. This ID can be retrieved using the read events request.

This event must be have its options.change_participation_status flag set to true.

status required  #

A String representing the participation status you’d like to set. Acceptable values are:

• accepted - to accept the invite
• tentative - to tentatively accept the invite
• declined - to decline the invite

Error responses #

must_be_external_event_uid

The UID of a partner event was provided, but this must be an external event UID. External event UIDs will start with evt_external, while partner event UIDs will start with evt_partner.

Events created in the calendars of any invitees of the managed event are synced as external events. When you create a managed event using the events API, the host’s participation in that event is ‘accepted’ by default.