Update notification subscription
Change a notification subscription: its events, event options, campaign filter, label, destination or enabled state. The destination, secret and headers are write-only; send a new value to replace one.
apiKeyAuthx-api-key<token>API key for authentication. Keys are prefixed with cops_.
id*stringSubscription id from list_notification_subscriptions.
^nsub_.+[\s\S]*$application/json- body
destination?stringThe webhook URL. Write-only: it is never returned. Not needed for a personal email subscription, which always sends to your account email.
eventTypes?array<>Event type keys from list_notification_event_types. An empty list sends every instant event, or with campaignIds every instant campaign event; a digest is sent only when listed.
eventOptions?Options for the event types in eventTypes, keyed by event type. The optionsSchema of each event type in list_notification_event_types gives its options and their defaults; an option you leave out uses its default. Replaces all stored options. Omit to keep them.
campaignIds?array<string>Only send events about these campaigns (ids from list_campaigns). A campaign filter works only with event types whose scope is campaign in list_notification_event_types. An empty list means no filter.
secret?|custom_webhook only: the signing secret (whsec_ followed by base64 is recommended). Write-only; null removes it.
customHeaders?|custom_webhook only: extra request headers as name to value. Write-only; null removes them.
label?|Display name for the destination. The daily digest uses it as a title prefix.
enabled?booleanfalse pauses the subscription without deleting it.
Response schema unavailable.
curl -X PATCH 'https://cops.app/api/brand/notifications/subscriptions/string' \ -H 'Content-Type: application/json' \ -d '{}'Get notification subscription GET
Get one notification subscription by id, with its events, filters and last delivery result.
Delete notification subscription DELETE
Delete a notification subscription and its delivery history. To pause notifications, use update_notification_subscription with enabled: false instead.