Skip to content

Deactivate Inbox Mailboxes

POST
/inbox/mailboxes/deactivate

Stop polling several mailboxes at once.

Takes the same body as activate - the campaign and auto-respond fields are simply ignored on this path, which is the app’s own shape and is left alone rather than split into a narrower model that would drift from it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Start (or stop) syncing several mailboxes in one call.

ALL-OR-NOTHING on activate: the app returns 400 if ANY mailbox fails, and the ones that succeeded stay activated. Read the failed list in the error body rather than assuming nothing happened.

object
auto_respond
Any of:
boolean
campaign_id
Any of:
string
campaign_name
Any of:
string
last_unread_limit
Any of:
integer
mailboxes
required
Array<object>
>= 1 items

One mailbox in a bulk activate/deactivate request.

object
display_name
Any of:
string
mailbox
required

The mailbox address.

string
provider
required
string
Allowed values: google_mailbox smtp

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