Updates a single subscription. To pause an active subscription, set the status request parameter to paused. To unpause a paused subscription, set the status request parameter to active. Always supply a status reason in the request when you update the subscription status. Changes made to a subscription can take up to two minutes to become active.
| Name | Type | | Description |
|---|
| subscriptionId | string | Required | Unique identifier for the subscription to update. |
| eventCategoryTypes | array | Required | Comma-separated list of fully qualified event types for which you’re requesting notifications. Expressed as NotificationEventCategory.NotificationEventType. Review Supported Notification Events for a list of supported event categories and types. |
| filters | array | | Each string in the array is a key=value pair to filter on. Review Subscription Filters for a list of data items available for filtering. |
| subscriptionName | string | | Name of the subscription. This name must be unique. |
| status | string | | Indicates the status of the callback subscription. Can be set to either active or paused. You can only pause active callback subscriptions. You can only make paused callback subscriptions active. |
| statusReason | string | | Describes why you changed the status. |
| Response | Reason |
|---|
| 200 OK | Callback description updated. Review example response. |
| 304 No Change | Update already exists on the server. |
| 400 Bad Request | Invalid request |
| 403 Forbidden | Failed to pass authorization. |
| 500 Server Error | Internal error |