Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/notices/{noticeId}/dismiss \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
noticeId (path) | string | Ano | — |
org_id (query) | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 429