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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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`	Ні	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 422

POST /v1/inbox/threads/{threadKey}