notifications

DELETE `/v1/notification-connections/{connection_id}`

Disconnect a destination.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/notification-connections/{connection_id} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Removes the destination, its routing cells, and its stored credential. The credential is removed from the vault FIRST and the result is reported rather than assumed: if the row went first and the vault delete failed, a live Slack token or webhook secret would be orphaned under a path no row names - un-enumerable, which is worse than a leak you can list.

Parameters

Name	Type	Required	What it is
`connection_id (path)`	`string`	Yes	—
`org_id (query)`	`string`	No	The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422…

Response

Name	Type	Required	What it is
`deleted`	`boolean`	No	—
`credential_removed`	`boolean`	No	Whether the stored credential was actually removed. False means the vault could not be reached - the destination is gone but an operator must clean up. Reported rather than sile…