Skip to content

Set Inbox Email Sequence

POST
/inbox/emails/{email_id}/sequence

Attribute a thread to a sequence, WITHOUT touching the sequencer.

The quiet twin of link-sequence: it re-labels the thread for reporting and does not tell the sequencer anything, so the contact keeps receiving the remaining steps. Use link-sequence when someone replied.

Accepts any id - unlike link-sequence there is no candidate check - so a wrong value mislabels the thread silently. Gated on visibility of the owning mailbox.

Authorizations

Parameters

Path Parameters

email_id
required

Email thread id.

string

Email thread id.

Query Parameters

sequence_id
required

Sequence (campaign) id to attribute the thread to.

string

Sequence (campaign) id to attribute the thread to.

sequence_name
required

Display name stored alongside the id.

string

Display name stored alongside the id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string