Inbox

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

Mark a conversation read, or archive it.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`threadKey (path)`	`string`	Po	—
`org_id (query)`	`Uuid`	Jo	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…

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`action`	`string<read, archive>`	Po	—

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`marked_read`	`integer`	Jo	—
`archived`	`integer`	Jo	—
`unread`	`integer`	Jo	—
`capped`	`boolean`	Jo	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 422