Update Mailbox

PATCH

/mailboxes/{mailbox_id}

• Production
• QA

Update a mailbox. Only supplied fields change; omitted fields are untouched.

Authorizations

• BearerAuth

Parameters

Path Parameters

mailbox_id

required

Mailbox ID (mailboxes.id)

integer

Mailbox ID (mailboxes.id)

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Partial update. Only supplied fields are changed.

object

allows_nurture

Any of:

boolean

boolean

null

null

daily_limit

Any of:

integer

integer

>= 1

null

null

display_name

Any of:

string

string

null

null

imap_address

Any of:

string

string

null

null

imap_password

Any of:

string

string

null

null

imap_port

Any of:

integer

integer

null

null

imap_username

Any of:

string

string

null

null

signature_html

Any of:

string

string

null

null

signature_plain

Any of:

string

string

null

null

smtp_address

Any of:

string

string

null

null

smtp_password

Any of:

string

string

null

null

smtp_port

Any of:

integer

integer

null

null

smtp_username

Any of:

string

string

null

null

use_html_signature

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

object

data

required

A sending mailbox. Credentials are never returned.

object

allows_nurture

Any of:

boolean

boolean

null

null

connection_status

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

created_by

Any of:

string

string

null

null

daily_limit

Any of:

integer

integer

null

null

display_name

Any of:

string

string

null

null

email

Any of:

string

string

null

null

id

required

integer

is_archived

Any of:

boolean

boolean

null

null

provider

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

warmup_enabled

Any of:

boolean

boolean

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string