Use the API to programmatically disable one or more subscriptions from receiving events in the future.

The Deactivate Subscription API function disables a subscription from receiving any events in the future. Once a subscription has been deactivated, any new events published will not appear in their calendar.
You can either specify an individual subscription to deactivate or all subscriptions that belong to a username for a calendar.
This API function is protected by OAuth and must include an Access Token token in the same way it is required to create a subscription.

Deactivate Subscription Parameters

ParameterTypeDescription
id

Optional
UUID/GUIDId of subscription to deactivate
username

Optional
StringThe username to deactivate all subscriptions for
Path Params
string
required

The Rokt Calendar merchant account code, or the subdomain of your Rokt Calendar dashboard URL.

string
required

This is a unique identifier of a specific calendar in your Rokt Calendar account. It is the URL slug that appears directly after the domain. For example if your calendar URL is http://youraccount.roktcalendar.com/my-calendar then the calCode will be my-calendar.

Headers
string

A Bearer token using your access token received via OAuth authentication

Responses

Language
Request
Choose an example:
application/json