Inbox

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

Mark a conversation read, or archive it.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Където отива идентификаторът на вашата организация

Този ендпойнт приема 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 конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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 agen…

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`action`	`string<read, archive>`	Да	—

Отговор

Име	Тип	Задължително	Какво представлява
`marked_read`	`integer`	Не	—
`archived`	`integer`	Не	—
`unread`	`integer`	Не	—
`capped`	`boolean`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 422

POST /v1/inbox/threads/{threadKey}