Skip to main content
PATCH
Update thread

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
text
string
Minimum string length: 1
title
string | null
Maximum string length: 512
pain_level
enum<string>
Available options:
UNKNOWN,
LOW,
MEDIUM,
HIGH
assignee_id
string | null

Workspace user id. Pass null to unassign.

contact_id
string
company_id
string | null

Pass null to detach. Also propagates onto the thread's contact.

tag_ids
string[]

Replaces the thread's full tag set.

project_id
string | null
status
enum<string>

When snoozed, snoozed_until is required.

Available options:
open,
snoozed,
done
snoozed_until
string<date-time>
closed_loop
boolean

With status=done, marks the thread as fully closed.

ai_draft_html
string | null

HTML body prefilled into the composer for the next outbound reply. Setting this stamps ai_draft_generated_at and clears ai_draft_started_at + ai_draft_error_at. Pass null (or an empty string) to clear the draft.

ai_draft_sources
array | null

Sources the AI consulted while generating the draft. Surfaces in the composer's "Drafted by AI" tooltip. Shape: { type, title, identifier?, url? }[]. Pass null to clear.

clear_ai_draft_error
boolean

When true, clears ai_draft_error_at. Use this to dismiss a stuck error pill in the composer without writing a new draft.

notify
object

Side-channel notifications to fire alongside the write (Slack and/or email).

Response

Successful response

id
string
required
created_at
string
required
updated_at
string
required
title
string | null
required
text
string
required
pain_level
enum<string>
required
Available options:
UNKNOWN,
LOW,
MEDIUM,
HIGH
origin
string
required
status
enum<string>
required
Available options:
open,
snoozed,
done
tab
enum<string>
required
Available options:
open,
new,
needs-response,
my,
snoozed,
done
snoozed_until
string | null
required
last_inbound_message_at
string | null
required
last_outbound_message_at
string | null
required
last_state_change_at
string | null
required
is_read
boolean
required
contact
object | null
required
company
object | null
required
assignee
object | null
required
reporter
object | null
required
tags
object[]
required
customer_needs
object[]
required
external_ids
object
required
ai_draft_html
string | null
required
ai_draft_sources
array | null
required
ai_draft_generated_at
string | null
required
ai_draft_started_at
string | null
required
ai_draft_error_at
string | null
required