Inbox

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

Mark a conversation read, or archive it.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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.

Параметри

Назив	Тип	Обавезно	Шта је ово
`threadKey (path)`	`string`	Да	—
`org_id (query)`	`Uuid`	Не	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 agency…

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`action`	`string<read, archive>`	Да	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`marked_read`	`integer`	Не	—
`archived`	`integer`	Не	—
`unread`	`integer`	Не	—
`capped`	`boolean`	Не	—

Грешке које ова крајња тачка може вратити

401 · 403 · 422

POST /v1/inbox/threads/{threadKey}