Skip to main content
POST
Pause a mailbox

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Maximum string length: 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

id
string<uuid>
required
Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

Response

id
string<uuid>
required
Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

emailAddress
string
required
firstName
string | null
required
Example:

"Jane"

lastName
string | null
required
Example:

"Doe"

displayName
string | null
required
Example:

"Jane Doe"

provider
string
required

How the mailbox is connected: custom for any SMTP/IMAP mailbox (including Gmail/Outlook connected with an app password), or google / microsoft for a native OAuth connection.

Example:

"custom"

status
enum<string>
required

Current state. active - sending. inactive - paused by you (or connected but not verified yet); nothing re-activates it on its own, call resume. checking - being verified. failed - we stopped it after repeated failures; see statusMessage for the provider’s reason, and resume re-checks it. revoked - the OAuth grant is gone; reconnect it.

Available options:
active,
inactive,
checking,
revoked,
failed
maxEmailsPerDay
number
required

Daily CAMPAIGN send cap. Warmup is budgeted separately (warmup.maxPerDay).

Example:

30

sendingGapMinutes
number
required

Minimum minutes between two sends from this mailbox, across all campaigns.

Example:

10

campaignSlowRamp
boolean
required

Ramp campaign volume up gradually when the mailbox joins a campaign.

Example:

false

replyToAddress
string | null
required

Where replies are sent, when it differs from the mailbox address.

signature
string | null
required

HTML signature appended to outgoing emails.

Example:

"Best regards,<br>Jane"

bcc
string | null
required
automationLanguage
string
required

ISO 639-1 language for auto-generated content.

Example:

"en"

warmup
object
required
tracking
object
required
statusMessage
object | null
required

Why the mailbox last failed, as reported by its provider. Null when it is healthy, and also null when the failure was on our side, since that is not a problem with your mailbox.

tags
object[]
required

Tags on this mailbox. Create and delete them in the dashboard - here they are read, and you can filter the list by them with ?tags=.

healthScore
number
required

Deliverability health score, from 0 to 100.

Example:

98

smtp
object
required
imap
object | null
required

Null when no IMAP is configured.

verification
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required