CloudKit Web Services Reference: Modifying Subscriptions (subscriptions/modify)

You can create, update, and delete subscriptions.

POST [path]/database/[version]/[container]/[environment]/[database]/subscriptions/modify

path: The URL to the CloudKit web service, which is https://api.apple-cloudkit.com.
version: The protocol version—currently, 1.
container: A unique identifier for the app’s container. The container ID begins with iCloud..
environment: The version of the app’s container. Pass development to use the environment that is not accessible by apps available on the store. Pass production to use the environment that is accessible by development apps and apps available on the store.
database: The database to store the data within the container. Pass public to use the database that is accessible to all users of the app. Pass private to use the database that is visible only to the currently signed-in user.

The POST request is a JSON dictionary containing the following keys:


Key	Description
`operations`	An array of dictionaries defining the operations to apply to subscriptions in the database. The dictionary keys are described in Subscription Operation Dictionary. See Data Size Limits for the maximum number of operations allowed. This key is required.

The subscription operation dictionary keys are:


Key	Description
`operationType`	The type of operation. Possible values are: `"create"` to create a new subscription. `"update"` to change an existing subscription. `"delete"` to delete a subscription. This key is required.
`subscription`	The subscription to apply the operation to, described in Subscription Dictionary, with the following differences: If the `subscriptionType` key is `"zone"`, the `query`, the `zoneID`, `firesOn`, and `firesOnce` keys are omitted. If the `subscriptionType` key is `"query"`, the `zoneWide` Boolean key is included. The default value for the `zoneWide` key is `true`. This key is required.

The response is a dictionary containing the results for each subscription with the following key:


Key	Description
`subscriptions`	An array containing one dictionary for each subscription. If the operation was successful, the dictionary contains the subscription information, described in Subscription Dictionary. If the operation was unsuccessful, the dictionary is an error dictionary, described in Subscription Fetch Error Dictionary.

This request is similar to using the CKModifySubscriptionsOperation class in the CloudKit framework.