Email Accounts

Connect mailboxes

Connect one SMTP/IMAP mailbox, or up to 50 at once. Any provider works, including Gmail and Outlook with an app password. There is no limit on how many mailboxes a workspace may connect.

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

post/v1/accounts

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/accounts
  • 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

Example request

{
  "accounts": [
    {
      "emailAddress": "jane@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "displayName": "Jane Doe",
      "smtpHost": "smtp.acme.com",
      "smtpPort": 587,
      "smtpUsername": "jane@acme.com",
      "smtpPassword": "your-password",
      "imapHost": "imap.acme.com",
      "imapPort": 993,
      "imapUsername": "jane@acme.com",
      "imapPassword": "your-password",
      "maxEmailsPerDay": 30,
      "sendingGapMinutes": 10,
      "signature": "Best regards,<br>Jane",
      "bcc": "archive@acme.com",
      "replyToAddress": "replies@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

Example response

{
  "summary": {
    "submitted": 2,
    "created": 1,
    "failed": 1
  },
  "accounts": [
    {
      "id": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
      "emailAddress": "jane@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "displayName": "Jane Doe",
      "provider": "custom",
      "maxEmailsPerDay": 30,
      "sendingGapMinutes": 10,
      "replyToAddress": "replies@acme.com",
      "signature": "Best regards,<br>Jane",
      "bcc": "archive@acme.com",
      "automationLanguage": "en",
      "warmup": {
        "enabled": true,
        "strategy": "standard",
        "maxPerDay": 15,
        "replyRatePercentage": 35,
        "rampupEnabled": true,
        "dailyRampup": 1,
        "timezone": "Europe/London",
        "trackingEnabled": true
      },
      "tracking": {
        "domainId": "9d1f7c4a-6e58-4b32-8a07-3c5d9e2f1b46"
      },
      "statusMessage": {
        "code": "EENVELOPE",
        "command": "DATA",
        "responseCode": 550,
        "response": "550-5.4.5 Daily user sending limit exceeded.",
        "message": "Daily user sending limit exceeded"
      },
      "tags": [
        {
          "id": "5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f",
          "name": "client-acme",
          "color": "#4F46E5"
        }
      ],
      "healthScore": 98,
      "smtp": {
        "host": "smtp.acme.com",
        "port": 587,
        "username": "jane@acme.com"
      },
      "imap": {
        "host": "imap.acme.com",
        "port": 993,
        "username": "jane@acme.com"
      }
    }
  ],
  "errors": [
    {
      "emailAddress": "jane@acme.com",
      "code": "mailbox_connected_elsewhere",
      "error": "This mailbox is already connected to another MailBeast workspace. Disconnect it there before adding it here."
    }
  ]
}

Changes

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