Skip to content

List Sequencer Mailboxes

GET
/sequencer/channels/mailboxes

Mailboxes available to send from, annotated as the app annotates them.

Carries the same warming, daily-capacity, warmup-ready and SURBL-listed annotations the in-app picker shows, so a rebuilt builder can surface the same warnings rather than silently offering a mailbox that cannot send.

Authorizations

Parameters

Query Parameters

email
required

Mailbox email to scope the picker to.

string

Mailbox email to scope the picker to.

exclude_sequence_id
Any of:
string

Hide mailboxes already attached to this sequence.

include_nurture

Include nurture-only mailboxes.

boolean

Include nurture-only mailboxes.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
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