Pause a mailbox
Stop sending from an active mailbox. It stays paused until you resume it - campaigns and warmup both skip it, and nothing re-activates it on its own. Returns 400 if the mailbox is not currently active.
Requires one of the following scopes: accounts:write, accounts:all, all:all.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
255"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Path Parameters
"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"
Response
"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"
"Jane"
"Doe"
"Jane Doe"
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.
"custom"
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.
active, inactive, checking, revoked, failed Daily CAMPAIGN send cap. Warmup is budgeted separately (warmup.maxPerDay).
30
Minimum minutes between two sends from this mailbox, across all campaigns.
10
Ramp campaign volume up gradually when the mailbox joins a campaign.
false
Where replies are sent, when it differs from the mailbox address.
HTML signature appended to outgoing emails.
"Best regards,<br>Jane"
ISO 639-1 language for auto-generated content.
"en"
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 on this mailbox. Create and delete them in the dashboard - here they are read, and you can filter the list by them with ?tags=.
Deliverability health score, from 0 to 100.
98
Null when no IMAP is configured.