Email Accounts

Bulk update mailboxes

Apply ONE settings/limits patch OR one status change (active/inactive) across many mailboxes. patch and status are mutually exclusive.

Requires one of the following scopes: accounts:write, accounts:all, all:all.

post/v1/accounts/bulk

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/accounts/bulk
  • Auth: HTTP bearer

Headers

Idempotency-Keystring
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

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.

Request body

idsstring[] required

Target account ids.

status'active' | 'inactive'

Enable (active) or disable (inactive) sending across the set. Mutually exclusive with patch.

Example request

{
  "ids": [
    "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
    "8c2f6a19-4b7d-4e53-91a0-5d3e7f6b2c84"
  ],
  "patch": {
    "displayName": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "maxEmailsPerDay": 60,
    "replyToAddress": "replies@acme.com",
    "sendingGapMinutes": 10,
    "signature": "Best regards,<br>Jane",
    "bcc": "archive@acme.com",
    "automationLanguage": "en",
    "tracking": {
      "domainId": "9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84"
    },
    "warmup": {
      "enabled": true,
      "strategy": "standard",
      "maxPerDay": 15,
      "replyRatePercentage": 35,
      "rampupEnabled": true,
      "dailyRampup": 1,
      "timezone": "Europe/London",
      "trackingEnabled": true
    }
  }
}

Response

updatednumber required

Accounts updated.

skippednumber required

Mailboxes that were not eligible for this change.

Example response

{
  "updated": 5,
  "skipped": 1,
  "skippedAccounts": [
    {
      "id": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
      "email": "jane@acme.com",
      "status": "checking",
      "reason": "Account is being verified."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.