Inbox

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

Mark a conversation read, or archive it.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja tačka ne navodi specifičnu dozvolu u specifikaciji, zato dodelite svom ključu minimum potrebnih ovlašćenja i proverite odgovor umesto da pretpostavljate.

Gde ide ID vaše organizacije

Ova krajnja tačka prihvata org_id kao parametar upita. Izostavite ga i poziv obuhvata celokupno stablo vašeg zakupca; pošaljite ga da biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na ekranu sa API ključevima u vašoj kontrolnoj tabli, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

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>> }'

Prijavljeni ste? API konzola na vašoj kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Detalji

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.

Parametri

Naziv	Vrsta	Obavezno	Šta je ovo
`threadKey (path)`	`string`	Da	—
`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…

Telo zahteva

Naziv	Vrsta	Obavezno	Šta je ovo
`action`	`string<read, archive>`	Da	—

Odgovor

Naziv	Vrsta	Obavezno	Šta je ovo
`marked_read`	`integer`	Ne	—
`archived`	`integer`	Ne	—
`unread`	`integer`	Ne	—
`capped`	`boolean`	Ne	—

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 422