notices

POST `/v1/notices/{noticeId}/dismiss`

The customer closed a notice.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

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 POST https://api.zinndigital.com/v1/notices/{noticeId}/dismiss \
  -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

Per user, not per organization — a colleague dismissing a promotion must not remove it from everyone else's dashboard. Idempotent, and 204 whether or not the id resolved: "I have closed this" cannot fail from the customer's side, and answering differently for an id they are not in the audience for would confirm that a notice exists.

Parameters

Name	Type	Required	What it is
`noticeId (path)`	`string`	Yes	—
`org_id (query)`	`string`	No	—

Errors this endpoint can return

401 · 429