Pause the mailbox: campaigns stop emailing from it until it is resumed. Its campaign leads stay assigned. Pausing an already-paused mailbox is a no-op and still returns the mailbox. Emits an account.paused webhook with channel: email.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/email-accounts/string/pause"{ "data": { "id": "string", "label": "string", "email": "string", "fromName": "string", "provider": "google", "authType": "password", "connectedVia": "app", "hostedLinkId": "string", "status": "pending", "error": "string", "limits": {}, "usage": {}, "paused": true, "pausedReason": "user", "pausedAt": "2019-08-24T14:15:22Z", "trackOpens": true, "trackClicks": true, "dnsHealth": { "domain": "string", "managed": true, "spf": { "status": "ok", "reason": "string" }, "dkim": { "status": "ok", "reason": "string", "selector": "string" }, "dmarc": { "status": "ok", "reason": "string", "policy": "none" }, "checkedAt": "2019-08-24T14:15:22Z" }, "deliverabilityTest": { "status": "running", "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "landing": "inbox", "spf": "string", "dkim": { "result": "string", "selector": "string" }, "dmarc": "string", "blocklists": { "ip": "clean", "domain": "clean" }, "failure": "send" }, "counters": {}, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "managed": { "provider": "string", "domain": "string", "status": "string", "renewsAt": "2019-08-24T14:15:22Z", "cancelAt": "2019-08-24T14:15:22Z", "isAdmin": true }, "warmup": { "provider": "string", "status": "pending", "statusLabel": "string", "strategy": { "preset": "conservative", "startingVolume": 1, "dailyIncrease": 1, "targetVolume": 1, "replyInbox": [ 0, 0 ], "replyPromotions": [ 0, 0 ], "replySpam": 0 }, "strategyApplied": true, "day": 0, "currentVolume": 0, "targetVolume": 0, "health": "excellent", "healthLabel": "string", "healthScore": 0, "inboxRate": 0, "startedAt": "2019-08-24T14:15:22Z", "holdUntil": "2019-08-24T14:15:22Z", "holdReason": "warming", "holdOverride": true, "syncedAt": "2019-08-24T14:15:22Z", "error": "string" }, "restoredFrom": "string" }}List mailboxes GET
Connected mailboxes, newest first, with their status, pause state (`paused` / `pausedReason`), daily limit and usage, and the gateway counters (`counters.sent`, `bounced`, `complained`). Credentials are never returned. A Google or Microsoft mailbox connects over the API through a hosted link (POST /email-accounts/hosted-link); mailboxes on a password are connected from the app.
Remove a mailbox DELETE
Remove the mailbox from the workspace: its email threads go with it, it leaves every campaign pool, and leads it was emailing move to the remaining mailboxes. Its threads are deleted. Connecting the same address again within the restore window (15 days by default, set by Swarmhit) brings it back to its campaigns, its leads and its settings, under a new id with `restoredFrom` set; after the window it comes back as a new mailbox. Needs the email channel enabled for the workspace (`403` otherwise). A mailbox bought through Swarmhit (`managed` set) is never removed this way: `409` with `code: managed-mailbox`; cancel it with POST /email-accounts/{id}/cancel-managed instead.