Inbox

POST `/v1/inbox/threads/{threadKey}`

Mark a conversation read, or archive it.

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/inbox/threads/{threadKey} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "action": <string<read, archive>> }'

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

A POST and not a GET, because a read receipt is a write — a GET that mutates is one a prefetcher, a crawler or the back button fires on the customer's behalf.

Parametry

Název	Typ	Požadováno	Co to je
`threadKey (path)`	`string`	Ano	—
`org_id (query)`	`Uuid`	Ne	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agen…

Tělo požadavku

Název	Typ	Požadováno	Co to je
`action`	`string<read, archive>`	Ano	—

Odpověď

Název	Typ	Požadováno	Co to je
`marked_read`	`integer`	Ne	—
`archived`	`integer`	Ne	—
`unread`	`integer`	Ne	—
`capped`	`boolean`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422