Inbox

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

Mark a conversation read, or archive it.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`threadKey (path)`	`string`	Sim	—
`org_id (query)`	`Uuid`	Não	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…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`action`	`string<read, archive>`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`marked_read`	`integer`	Não	—
`archived`	`integer`	Não	—
`unread`	`integer`	Não	—
`capped`	`boolean`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 422