Use the API to programmatically update a calendar subscription

This API function requires that your application be authenticated via OAuth. You can learn how to authenticate your application here.

Subscription Update Parameters

ParameterTypeDescription
CalendarTags

Optional
CalendarTags[]Array of calendar tags to filter events by. Tags are used to group similar events. For example all events that belong to the same sporting team/topic can be tagged with a team name.

When a tagId is used, the subscription will only include events tagged with the selected tag.

See Calendar Tag Model for complete schema.
timeZoneId

Optional
StringWindows timezone identifier to filter events by. If used, the subscription will include events that are tagged with this time zone and any events that are not tagged with a time zone.

See Timezones for available list.
requestEventIds

Optional
String[]
(UUID/GUID)
An array of event identifiers to exclusively include in the calendar subscription. Identifiers that do not match will be ignored.
externalEventIds

Optional
String[]One or more identifiers that represents unique events to you that will be exclusively include in the calendar subscription. . Identifiers that do not match will be ignored.
excludeRequestEventIds

Optional
String[]
(UUID/GUID)
An array of event identifiers to exclude from the calendar subscription. Identifiers that do not match will be ignored.
excludeExternalEventIds

Optional
String[]One or more identifiers that represents unique events to you that will be excluded from the calendar subscription. Identifiers that do not match will be ignored.
marketingAllowed

Optional
BooleanMarketing opt-in allows the subscriber to specify if they give permission for their email address to be used for marketing purposes.
additionalOptIn

Optional
BooleanAdditional opt-in allows the subscriber to specify if they are opting-in to the question/statement as defined by the copy associated with the checkbox.
redirectTo

Optional
StringThe url to redirect the user to after the subscription has been created. (Required for Google subscriptions)

Response

ParameterTypeDescription
success

Always present
BooleanRepresents if the create subscription was successful
statusCode

Always present
NumberHTTP error codes if request was not successful
errors

Always present
String[]List of error messages if request was not successful
message

Sometimes present
StringConfirmation message
subscriptionId

Sometimes present
UUID/GUIDThe unique identifier of the subscription that was being updated
subscriberId

Sometimes present
StringIdentifier that represents a unique user to you. E.g. email address, device id, anonymous id
subscriptionType

Sometimes present
StringType of subscription that is being updated. Currently can only be Google, WebCal or Microsoft
RedirectTo

Sometimes present
StringUrl to redirect the user to, to complete reauthorization.

🚧

Google Subscriptions

Users with Google subscriptions can revoke permission to their calendar via their Google Account Settings. In cases where this has occurred we require the user to reauthorize us so we can access their calendar and update it. This is achieved by passing back a url to the Google Consent form in the redirectTo property of the response. You must redirect the user and upon completion of the consent form we will redirect the use back to you with the result.

Google Reauthorization

After the user has selected an option on the consent form we will redirect the user back to the caller using the redirectTo url provided in the request and the result as query parameters.

ParameterTypeDescription
success

Always present
BooleanIndicates if the subscription was created successfully.
subscriptionId

Sometimes present
UUID/GUIDUnique identifier of the subscription.
subscriberId

Sometimes present
StringIdentifier that represents a unique user to you given to us in initial request.
errors

Sometimes present
Errors[]
(Json)
Json serialize array of Errors
Language