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}