Inbox

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

Mark a conversation read, or archive it.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Parameters

Name	Type	Required	What it is
`threadKey (path)`	`string`	Yes	—
`org_id (query)`	`Uuid`	No	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…

Request body

Name	Type	Required	What it is
`action`	`string<read, archive>`	Yes	—

Response

Name	Type	Required	What it is
`marked_read`	`integer`	No	—
`archived`	`integer`	No	—
`unread`	`integer`	No	—
`capped`	`boolean`	No	—

Errors this endpoint can return

401 · 403 · 422