notifications

PUT /v1/notification-routes

Turn a notification topic on or off for one destination.

All notifications endpoints

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 PUT https://api.zinndigital.com/v1/notification-routes \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "routes": <object[]> }'

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

Flips cells of the matrix. `enabled: true` DELETES the stored deviation, returning the cell to the default; `enabled: false` writes one. Keeping a true row would make "on" mean two different stored states and the grid would drift.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNoThe 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…

Request body

NameTypeRequiredWhat it is
routesobject[]Yes

Response

NameTypeRequiredWhat it is
okbooleanNo