Skip to content

Toggle Inbox Mailboxes

PATCH
/inbox/mailboxes/bulk

Flip several mailboxes on or off by address, and optionally set auto-respond on all of them in the same call.

PARTIALLY TOLERANT where activate is not: this one reports failures in the body and still returns 200. Check total_failed.

activate is explicit rather than a toggle, so a retried request is idempotent instead of putting the mailboxes back the way they were.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Flip several mailboxes on or off, and optionally set auto-respond.

activate is explicit rather than a toggle, so a retried request is idempotent instead of flipping the state back.

object
activate
required

True starts syncing, false stops it.

boolean
auto_respond
Any of:
boolean
mailboxes
required

Mailbox addresses.

Array<string>
>= 1 items

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