Skip to main content
POST
Archive Thread
Archive an inbox conversation thread. Requires the contacts:write scope on the API key.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

thread_id
string
required

ID of the thread.

Response

200 - application/json

Successful Response

thread_id
string
required

The external thread identifier.

archived
boolean
required

Whether the thread is currently archived.