Skip to main content
PATCH
CLI
Acts as the user who created the key and sends nothing to the contact. Pass at least one field. Booleans must be JSON booleans (true, not "true").

Use Cases

  • Mark as handled: { "markRead": true, "status": "closed" }
  • Take a conversation: { "assignTo": "me" } assigns it to the key’s user and clears the AI’s handover request
  • Come back later: { "status": "snoozed", "snoozedUntil": "2026-11-20T09:00:00Z" }

Permissions

The API key needs the Inbox permission.

Common Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

threadId
integer
required

The threadId from List Threads or Search Threads.

Body

application/json
markRead
boolean

true = read, false = unread again.

status
enum<string>
Available options:
open,
closed,
snoozed
snoozedUntil
string<date-time>

Required with status: "snoozed", in the future.

assignTo

"me", a teammate's user id (from assignedTo.userId), or null to unassign. Assigning notifies the person and clears the AI's handover request.

Available options:
me
pinned
boolean

Pin to the top of the inbox.

Response

The updated thread

data
object