> ## Documentation Index > Fetch the complete documentation index at: https://developer.mailbeast.ai/llms.txt > Use this file to discover all available pages before exploring further. # Resume a mailbox > Start sending from a mailbox again. One you paused resumes immediately; one we stopped after repeated failures is re-verified first and only resumes if the check passes. Requires one of the following scopes: `accounts:write`, `accounts:all`, `all:all`. ## OpenAPI ````yaml /openapi.json post /v1/accounts/{id}/resume openapi: 3.0.0 info: title: MailBeast Public API description: >- Task-shaped REST API for campaigns, leads, deliverability, verification and lead discovery. Authenticate with an API key (`Authorization: Bearer mb_live_…`); the workspace is resolved from the key. version: '1' contact: {} servers: - url: https://api.mailbeast.ai security: [] tags: - name: API Keys description: Create, list and revoke API keys programmatically. - name: Campaigns description: Create, configure, launch and monitor email campaigns. - name: Leads description: Add, read, update and bulk-manage a campaign’s leads. - name: Workspace description: Read usage, subscription and workspace identity. - name: Email Accounts description: >- Connect and manage the sending mailboxes your campaigns send from (SMTP/IMAP or native OAuth). - name: Analytics description: Engagement reporting – per campaign, over time, and across the workspace. - name: Lead Finder description: >- Discover new companies and leads. List past searches and poll a running search’s progress. paths: /v1/accounts/{id}/resume: post: tags: - Email Accounts summary: Resume a mailbox description: >- Start sending from a mailbox again. One you paused resumes immediately; one we stopped after repeated failures is re-verified first and only resumes if the check passes. Requires one of the following scopes: `accounts:write`, `accounts:all`, `all:all`. operationId: accounts_resume parameters: - name: id required: true in: path schema: type: string format: uuid example: 3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93 - name: Idempotency-Key in: header description: >- 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`. required: false schema: type: string maxLength: 255 example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AccountApiDto' '400': description: The request body or parameters failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: validation_failed message: One or more fields are invalid. status: 400 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f details: - name should not be empty '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: authentication_error code: unauthenticated message: Missing or invalid API key. status: 401 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '403': description: >- The key lacks a required scope, or the plan does not include API access. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: authorization_error code: permission_denied message: This API key is missing the required scope. status: 403 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '404': description: The resource does not exist in your workspace. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: not_found message: Resource not found. status: 404 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '409': description: >- The request conflicts with current state - e.g. a request with the same Idempotency-Key is still being processed, or the operation partially applied. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: conflict message: The request conflicts with an existing resource. status: 409 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '422': description: >- The Idempotency-Key was already used with a different request body. Use a new key for a new operation. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: idempotency_key_reused message: >- The Idempotency-Key was already used with a different request body. Use a new key for a new operation. status: 422 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '429': description: >- Rate limit exceeded - retry after the interval in the Retry-After header. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: rate_limit_error code: rate_limited message: >- Too many requests. Retry after the interval in the Retry-After header. status: 429 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f retryAfter: 30 security: - ApiKey: [] components: schemas: AccountApiDto: type: object properties: id: type: string format: uuid example: 3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93 emailAddress: type: string example: jane@acme.com firstName: type: string nullable: true example: Jane lastName: type: string nullable: true example: Doe displayName: type: string nullable: true example: Jane Doe provider: type: string example: custom description: >- 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. status: type: string enum: - active - inactive - checking - revoked - failed description: >- 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. maxEmailsPerDay: type: number example: 30 description: >- Daily CAMPAIGN send cap. Warmup is budgeted separately (`warmup.maxPerDay`). sendingGapMinutes: type: number example: 10 description: >- Minimum minutes between two sends from this mailbox, across all campaigns. campaignSlowRamp: type: boolean example: false description: Ramp campaign volume up gradually when the mailbox joins a campaign. replyToAddress: type: string nullable: true example: replies@acme.com description: Where replies are sent, when it differs from the mailbox address. signature: type: string nullable: true example: Best regards,
Jane description: HTML signature appended to outgoing emails. bcc: type: string nullable: true example: archive@acme.com automationLanguage: type: string example: en description: ISO 639-1 language for auto-generated content. warmup: $ref: '#/components/schemas/AccountWarmupSummaryDto' tracking: $ref: '#/components/schemas/AccountTrackingSummaryDto' statusMessage: nullable: true description: >- 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. type: object allOf: - $ref: '#/components/schemas/AccountStatusMessageDto' tags: description: >- 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=`. type: array items: $ref: '#/components/schemas/TagApiDto' healthScore: type: number example: 98 description: Deliverability health score, from 0 to 100. smtp: $ref: '#/components/schemas/AccountSmtpDto' imap: nullable: true description: Null when no IMAP is configured. type: object allOf: - $ref: '#/components/schemas/AccountImapDto' verification: $ref: '#/components/schemas/AccountVerificationSummaryDto' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - emailAddress - firstName - lastName - displayName - provider - status - maxEmailsPerDay - sendingGapMinutes - campaignSlowRamp - replyToAddress - signature - bcc - automationLanguage - warmup - tracking - statusMessage - tags - healthScore - smtp - imap - verification - createdAt - updatedAt ApiErrorDto: type: object properties: error: $ref: '#/components/schemas/ApiErrorBodyDto' required: - error AccountWarmupSummaryDto: type: object properties: enabled: type: boolean example: true strategy: type: string enum: - standard - aggressive - custom example: standard description: >- Fixed preset (`standard` / `aggressive`), or `custom` to run on the tuning values below. maxPerDay: type: number example: 15 description: >- Warmup emails per day. Separate from the campaign cap. Honoured while ramping up on `custom` only; from the maintaining stage on it caps every strategy. replyRatePercentage: type: number example: 35 description: '`custom` strategy only; the presets use their own reply rate.' rampupEnabled: type: boolean example: true description: '`custom` strategy only.' dailyRampup: type: number example: 1 description: >- Emails added per day while ramping. Read only when `rampupEnabled` is true. `custom` strategy only. randomizer: type: number example: 0 description: >- Percent of warmup sends randomly skipped each day. `custom` strategy only. skipWeekends: type: boolean example: false timezone: type: string example: Europe/London trackingEnabled: type: boolean example: true phase: type: string nullable: true enum: - warming_up - maintaining - active_with_campaigns description: >- Where the mailbox is in its warmup lifecycle. Null until warmup starts. startedAt: type: string nullable: true format: date-time description: When warmup began. Null if it never has. poolAccess: type: string enum: - free - standard - premium - ultra description: >- Quality of the warmup pool this mailbox converses with. Set by your plan, read-only. required: - enabled - strategy - maxPerDay - replyRatePercentage - rampupEnabled - dailyRampup - randomizer - skipWeekends - timezone - trackingEnabled - phase - startedAt - poolAccess AccountTrackingSummaryDto: type: object properties: domainId: type: string nullable: true format: uuid description: >- Tracking domain in use. Null means opens and clicks are not tracked for this mailbox. example: 9d1f7c4a-6e58-4b32-8a07-3c5d9e2f1b46 required: - domainId AccountStatusMessageDto: type: object properties: code: type: string nullable: true example: EENVELOPE description: Transport/protocol class of the failure. command: type: string nullable: true example: DATA description: The SMTP command that failed. responseCode: type: number nullable: true example: 550 description: Numeric SMTP status returned by the provider. response: type: string nullable: true example: 550-5.4.5 Daily user sending limit exceeded. description: The provider’s raw response line. message: type: string example: Daily user sending limit exceeded description: The error text. occurredAt: type: string format: date-time description: When the failure happened. required: - code - command - responseCode - response - message - occurredAt TagApiDto: type: object properties: id: type: string format: uuid example: 5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f name: type: string example: client-acme color: type: string nullable: true example: '#4F46E5' description: Hex colour shown in the dashboard. required: - id - name - color AccountSmtpDto: type: object properties: host: type: string nullable: true example: smtp.acme.com port: type: number nullable: true example: 587 username: type: string nullable: true example: jane@acme.com required: - host - port - username AccountImapDto: type: object properties: host: type: string nullable: true example: imap.acme.com port: type: number nullable: true example: 993 username: type: string nullable: true example: jane@acme.com required: - host - port - username AccountVerificationSummaryDto: type: object properties: overallStatus: type: string enum: - pending - verified - failed description: Overall outcome of the mailbox checks. smtp: type: string description: Sending status of the mailbox. enum: - active - inactive - checking - revoked - failed imap: type: string enum: - not_checked - pending - in_progress - verified - failed - check_unavailable - skipped description: IMAP connection status. dns: $ref: '#/components/schemas/AccountDnsDto' required: - overallStatus - smtp - imap - dns ApiErrorBodyDto: type: object properties: type: type: string example: authorization_error description: Broad error class. code: type: string example: permission_denied description: Stable machine-readable code to switch on. message: type: string example: This API key is missing the required scope. status: type: number example: 403 requestId: type: string example: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f description: Correlation id - quote it in support requests. details: description: Field-level validation messages (present on validation errors). example: - name should not be empty type: array items: type: string retryAfter: type: number description: Seconds to wait before retrying (present on 429 responses). example: 30 required: - type - code - message - status - requestId AccountDnsDto: type: object properties: mx: type: string enum: - not_checked - pending - in_progress - verified - failed - check_unavailable - skipped spf: type: string enum: - not_checked - pending - in_progress - verified - failed - check_unavailable - skipped dkim: type: string enum: - not_checked - pending - in_progress - verified - failed - check_unavailable - skipped dmarc: type: string enum: - not_checked - pending - in_progress - verified - failed - check_unavailable - skipped required: - mx - spf - dkim - dmarc securitySchemes: ApiKey: scheme: bearer bearerFormat: mb_live_… type: http ```` ## Related topics - [Pause a mailbox](/api-reference/email-accounts/pause-a-mailbox.md) - [Resume campaign](/api-reference/campaigns/resume-campaign.md) - [Email Accounts](/accounts.md) - [Get a mailbox](/api-reference/email-accounts/get-a-mailbox.md) - [Update a mailbox](/api-reference/email-accounts/update-a-mailbox.md)