Update a mailbox

curl --request PATCH \
  --url https://api.mailbeast.ai/v1/accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "displayName": "Jane Doe",
  "maxEmailsPerDay": 60,
  "sendingGapMinutes": 10,
  "campaignSlowRamp": false,
  "signature": "Best regards,<br>Jane",
  "bcc": "[email protected]",
  "replyToAddress": "[email protected]",
  "automationLanguage": "en",
  "tracking": {
    "domainId": "9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84"
  },
  "warmup": {
    "enabled": true,
    "strategy": "standard",
    "maxPerDay": 15,
    "replyRatePercentage": 35,
    "rampupEnabled": true,
    "dailyRampup": 1,
    "randomizer": 0,
    "skipWeekends": false,
    "timezone": "Europe/London",
    "trackingEnabled": true
  },
  "smtpHost": "smtp.acme.com",
  "smtpPort": 587,
  "smtpUsername": "[email protected]",
  "smtpPassword": "your-password",
  "imapHost": "imap.acme.com",
  "imapPort": 993,
  "imapUsername": "[email protected]",
  "imapPassword": "your-password",
  "imapAllowInvalidCert": false
}
'

import requests

url = "https://api.mailbeast.ai/v1/accounts/{id}"

payload = {
    "firstName": "Jane",
    "lastName": "Doe",
    "displayName": "Jane Doe",
    "maxEmailsPerDay": 60,
    "sendingGapMinutes": 10,
    "campaignSlowRamp": False,
    "signature": "Best regards,<br>Jane",
    "bcc": "[email protected]",
    "replyToAddress": "[email protected]",
    "automationLanguage": "en",
    "tracking": { "domainId": "9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84" },
    "warmup": {
        "enabled": True,
        "strategy": "standard",
        "maxPerDay": 15,
        "replyRatePercentage": 35,
        "rampupEnabled": True,
        "dailyRampup": 1,
        "randomizer": 0,
        "skipWeekends": False,
        "timezone": "Europe/London",
        "trackingEnabled": True
    },
    "smtpHost": "smtp.acme.com",
    "smtpPort": 587,
    "smtpUsername": "[email protected]",
    "smtpPassword": "your-password",
    "imapHost": "imap.acme.com",
    "imapPort": 993,
    "imapUsername": "[email protected]",
    "imapPassword": "your-password",
    "imapAllowInvalidCert": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'Jane',
    lastName: 'Doe',
    displayName: 'Jane Doe',
    maxEmailsPerDay: 60,
    sendingGapMinutes: 10,
    campaignSlowRamp: false,
    signature: 'Best regards,<br>Jane',
    bcc: '[email protected]',
    replyToAddress: '[email protected]',
    automationLanguage: 'en',
    tracking: {domainId: '9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84'},
    warmup: {
      enabled: true,
      strategy: 'standard',
      maxPerDay: 15,
      replyRatePercentage: 35,
      rampupEnabled: true,
      dailyRampup: 1,
      randomizer: 0,
      skipWeekends: false,
      timezone: 'Europe/London',
      trackingEnabled: true
    },
    smtpHost: 'smtp.acme.com',
    smtpPort: 587,
    smtpUsername: '[email protected]',
    smtpPassword: 'your-password',
    imapHost: 'imap.acme.com',
    imapPort: 993,
    imapUsername: '[email protected]',
    imapPassword: 'your-password',
    imapAllowInvalidCert: false
  })
};

fetch('https://api.mailbeast.ai/v1/accounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mailbeast.ai/v1/accounts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => 'Jane',
    'lastName' => 'Doe',
    'displayName' => 'Jane Doe',
    'maxEmailsPerDay' => 60,
    'sendingGapMinutes' => 10,
    'campaignSlowRamp' => false,
    'signature' => 'Best regards,<br>Jane',
    'bcc' => '[email protected]',
    'replyToAddress' => '[email protected]',
    'automationLanguage' => 'en',
    'tracking' => [
        'domainId' => '9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84'
    ],
    'warmup' => [
        'enabled' => true,
        'strategy' => 'standard',
        'maxPerDay' => 15,
        'replyRatePercentage' => 35,
        'rampupEnabled' => true,
        'dailyRampup' => 1,
        'randomizer' => 0,
        'skipWeekends' => false,
        'timezone' => 'Europe/London',
        'trackingEnabled' => true
    ],
    'smtpHost' => 'smtp.acme.com',
    'smtpPort' => 587,
    'smtpUsername' => '[email protected]',
    'smtpPassword' => 'your-password',
    'imapHost' => 'imap.acme.com',
    'imapPort' => 993,
    'imapUsername' => '[email protected]',
    'imapPassword' => 'your-password',
    'imapAllowInvalidCert' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mailbeast.ai/v1/accounts/{id}"

	payload := strings.NewReader("{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.mailbeast.ai/v1/accounts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mailbeast.ai/v1/accounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
  "emailAddress": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "displayName": "Jane Doe",
  "provider": "custom",
  "status": "active",
  "maxEmailsPerDay": 30,
  "sendingGapMinutes": 10,
  "campaignSlowRamp": false,
  "replyToAddress": "[email protected]",
  "signature": "Best regards,<br>Jane",
  "bcc": "[email protected]",
  "automationLanguage": "en",
  "warmup": {
    "enabled": true,
    "strategy": "standard",
    "maxPerDay": 15,
    "replyRatePercentage": 35,
    "rampupEnabled": true,
    "dailyRampup": 1,
    "randomizer": 0,
    "skipWeekends": false,
    "timezone": "Europe/London",
    "trackingEnabled": true,
    "phase": "warming_up",
    "startedAt": "2023-11-07T05:31:56Z",
    "poolAccess": "free"
  },
  "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",
    "occurredAt": "2023-11-07T05:31:56Z"
  },
  "tags": [
    {
      "id": "5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f",
      "name": "client-acme",
      "color": "#4F46E5"
    }
  ],
  "healthScore": 98,
  "smtp": {
    "host": "smtp.acme.com",
    "port": 587,
    "username": "[email protected]"
  },
  "imap": {
    "host": "imap.acme.com",
    "port": 993,
    "username": "[email protected]"
  },
  "verification": {
    "overallStatus": "pending",
    "smtp": "active",
    "imap": "not_checked",
    "dns": {
      "mx": "not_checked",
      "spf": "not_checked",
      "dkim": "not_checked",
      "dmarc": "not_checked"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthenticated",
    "message": "Missing or invalid API key.",
    "status": 401,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "permission_denied",
    "message": "This API key is missing the required scope.",
    "status": 403,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "Resource not found.",
    "status": 404,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "conflict",
    "message": "The request conflicts with an existing resource.",
    "status": 409,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "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"
  }
}

{
  "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
  }
}

PATCH

accounts

{id}

Update a mailbox

curl --request PATCH \
  --url https://api.mailbeast.ai/v1/accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "displayName": "Jane Doe",
  "maxEmailsPerDay": 60,
  "sendingGapMinutes": 10,
  "campaignSlowRamp": false,
  "signature": "Best regards,<br>Jane",
  "bcc": "[email protected]",
  "replyToAddress": "[email protected]",
  "automationLanguage": "en",
  "tracking": {
    "domainId": "9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84"
  },
  "warmup": {
    "enabled": true,
    "strategy": "standard",
    "maxPerDay": 15,
    "replyRatePercentage": 35,
    "rampupEnabled": true,
    "dailyRampup": 1,
    "randomizer": 0,
    "skipWeekends": false,
    "timezone": "Europe/London",
    "trackingEnabled": true
  },
  "smtpHost": "smtp.acme.com",
  "smtpPort": 587,
  "smtpUsername": "[email protected]",
  "smtpPassword": "your-password",
  "imapHost": "imap.acme.com",
  "imapPort": 993,
  "imapUsername": "[email protected]",
  "imapPassword": "your-password",
  "imapAllowInvalidCert": false
}
'

import requests

url = "https://api.mailbeast.ai/v1/accounts/{id}"

payload = {
    "firstName": "Jane",
    "lastName": "Doe",
    "displayName": "Jane Doe",
    "maxEmailsPerDay": 60,
    "sendingGapMinutes": 10,
    "campaignSlowRamp": False,
    "signature": "Best regards,<br>Jane",
    "bcc": "[email protected]",
    "replyToAddress": "[email protected]",
    "automationLanguage": "en",
    "tracking": { "domainId": "9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84" },
    "warmup": {
        "enabled": True,
        "strategy": "standard",
        "maxPerDay": 15,
        "replyRatePercentage": 35,
        "rampupEnabled": True,
        "dailyRampup": 1,
        "randomizer": 0,
        "skipWeekends": False,
        "timezone": "Europe/London",
        "trackingEnabled": True
    },
    "smtpHost": "smtp.acme.com",
    "smtpPort": 587,
    "smtpUsername": "[email protected]",
    "smtpPassword": "your-password",
    "imapHost": "imap.acme.com",
    "imapPort": 993,
    "imapUsername": "[email protected]",
    "imapPassword": "your-password",
    "imapAllowInvalidCert": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'Jane',
    lastName: 'Doe',
    displayName: 'Jane Doe',
    maxEmailsPerDay: 60,
    sendingGapMinutes: 10,
    campaignSlowRamp: false,
    signature: 'Best regards,<br>Jane',
    bcc: '[email protected]',
    replyToAddress: '[email protected]',
    automationLanguage: 'en',
    tracking: {domainId: '9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84'},
    warmup: {
      enabled: true,
      strategy: 'standard',
      maxPerDay: 15,
      replyRatePercentage: 35,
      rampupEnabled: true,
      dailyRampup: 1,
      randomizer: 0,
      skipWeekends: false,
      timezone: 'Europe/London',
      trackingEnabled: true
    },
    smtpHost: 'smtp.acme.com',
    smtpPort: 587,
    smtpUsername: '[email protected]',
    smtpPassword: 'your-password',
    imapHost: 'imap.acme.com',
    imapPort: 993,
    imapUsername: '[email protected]',
    imapPassword: 'your-password',
    imapAllowInvalidCert: false
  })
};

fetch('https://api.mailbeast.ai/v1/accounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mailbeast.ai/v1/accounts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => 'Jane',
    'lastName' => 'Doe',
    'displayName' => 'Jane Doe',
    'maxEmailsPerDay' => 60,
    'sendingGapMinutes' => 10,
    'campaignSlowRamp' => false,
    'signature' => 'Best regards,<br>Jane',
    'bcc' => '[email protected]',
    'replyToAddress' => '[email protected]',
    'automationLanguage' => 'en',
    'tracking' => [
        'domainId' => '9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84'
    ],
    'warmup' => [
        'enabled' => true,
        'strategy' => 'standard',
        'maxPerDay' => 15,
        'replyRatePercentage' => 35,
        'rampupEnabled' => true,
        'dailyRampup' => 1,
        'randomizer' => 0,
        'skipWeekends' => false,
        'timezone' => 'Europe/London',
        'trackingEnabled' => true
    ],
    'smtpHost' => 'smtp.acme.com',
    'smtpPort' => 587,
    'smtpUsername' => '[email protected]',
    'smtpPassword' => 'your-password',
    'imapHost' => 'imap.acme.com',
    'imapPort' => 993,
    'imapUsername' => '[email protected]',
    'imapPassword' => 'your-password',
    'imapAllowInvalidCert' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mailbeast.ai/v1/accounts/{id}"

	payload := strings.NewReader("{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.mailbeast.ai/v1/accounts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mailbeast.ai/v1/accounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"displayName\": \"Jane Doe\",\n  \"maxEmailsPerDay\": 60,\n  \"sendingGapMinutes\": 10,\n  \"campaignSlowRamp\": false,\n  \"signature\": \"Best regards,<br>Jane\",\n  \"bcc\": \"[email protected]\",\n  \"replyToAddress\": \"[email protected]\",\n  \"automationLanguage\": \"en\",\n  \"tracking\": {\n    \"domainId\": \"9b7d4e53-91a0-4c2f-8a19-5d3e7f6b2c84\"\n  },\n  \"warmup\": {\n    \"enabled\": true,\n    \"strategy\": \"standard\",\n    \"maxPerDay\": 15,\n    \"replyRatePercentage\": 35,\n    \"rampupEnabled\": true,\n    \"dailyRampup\": 1,\n    \"randomizer\": 0,\n    \"skipWeekends\": false,\n    \"timezone\": \"Europe/London\",\n    \"trackingEnabled\": true\n  },\n  \"smtpHost\": \"smtp.acme.com\",\n  \"smtpPort\": 587,\n  \"smtpUsername\": \"[email protected]\",\n  \"smtpPassword\": \"your-password\",\n  \"imapHost\": \"imap.acme.com\",\n  \"imapPort\": 993,\n  \"imapUsername\": \"[email protected]\",\n  \"imapPassword\": \"your-password\",\n  \"imapAllowInvalidCert\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
  "emailAddress": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "displayName": "Jane Doe",
  "provider": "custom",
  "status": "active",
  "maxEmailsPerDay": 30,
  "sendingGapMinutes": 10,
  "campaignSlowRamp": false,
  "replyToAddress": "[email protected]",
  "signature": "Best regards,<br>Jane",
  "bcc": "[email protected]",
  "automationLanguage": "en",
  "warmup": {
    "enabled": true,
    "strategy": "standard",
    "maxPerDay": 15,
    "replyRatePercentage": 35,
    "rampupEnabled": true,
    "dailyRampup": 1,
    "randomizer": 0,
    "skipWeekends": false,
    "timezone": "Europe/London",
    "trackingEnabled": true,
    "phase": "warming_up",
    "startedAt": "2023-11-07T05:31:56Z",
    "poolAccess": "free"
  },
  "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",
    "occurredAt": "2023-11-07T05:31:56Z"
  },
  "tags": [
    {
      "id": "5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f",
      "name": "client-acme",
      "color": "#4F46E5"
    }
  ],
  "healthScore": 98,
  "smtp": {
    "host": "smtp.acme.com",
    "port": 587,
    "username": "[email protected]"
  },
  "imap": {
    "host": "imap.acme.com",
    "port": 993,
    "username": "[email protected]"
  },
  "verification": {
    "overallStatus": "pending",
    "smtp": "active",
    "imap": "not_checked",
    "dns": {
      "mx": "not_checked",
      "spf": "not_checked",
      "dkim": "not_checked",
      "dmarc": "not_checked"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthenticated",
    "message": "Missing or invalid API key.",
    "status": 401,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "permission_denied",
    "message": "This API key is missing the required scope.",
    "status": 403,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "Resource not found.",
    "status": 404,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "conflict",
    "message": "The request conflicts with an existing resource.",
    "status": 409,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "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"
  }
}

{
  "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
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

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.

Maximum string length: 255

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

string<uuid>

required

Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

Body

application/json

firstName

string

Maximum string length: 128

Example:

"Jane"

lastName

string

Maximum string length: 128

Example:

"Doe"

displayName

string

Maximum string length: 128

Example:

"Jane Doe"

maxEmailsPerDay

number

Daily CAMPAIGN send cap. Warmup has its own budget (warmup.maxPerDay).

Required range: 1 <= x <= 200

Example:

60

sendingGapMinutes

number

Minimum minutes between two sends from this mailbox, across all campaigns.

Required range: 1 <= x <= 300

Example:

10

campaignSlowRamp

boolean

Example:

false

signature

string

HTML signature. Sanitized on save.

Example:

"Best regards,<br>Jane"

bcc

string

Maximum string length: 254

Example:

"[email protected]"

replyToAddress

string

Pass "" to clear it and reply to the mailbox address again.

Maximum string length: 254

Example:

"[email protected]"

automationLanguage

enum<string>

Available options:

en,

ar,

bn,

zh,

cs,

da,

nl,

fi,

fr,

de,

el,

he,

hi,

hu,

id,

it,

ja,

ko,

ms,

no,

pl,

pt,

ro,

ru,

es,

sv,

th,

tr,

uk,

vi

Example:

"en"

tracking

object

Show child attributes

warmup

object

Warmup config. Only the keys you send are changed. Turning enabled on for a mailbox that has been paused resumes it where it left off.

Show child attributes

smtpHost

string

Maximum string length: 255

Example:

"smtp.acme.com"

smtpPort

number

Required range: 1 <= x <= 65535

Example:

587

smtpUsername

string

Maximum string length: 255

Example:

"[email protected]"

smtpPassword

string

Maximum string length: 1024

Example:

"your-password"

imapHost

string

Maximum string length: 255

Example:

"imap.acme.com"

imapPort

number

Required range: 1 <= x <= 65535

Example:

993

imapUsername

string

Maximum string length: 255

Example:

"[email protected]"

imapPassword

string

Maximum string length: 1024

Example:

"your-password"

imapAllowInvalidCert

boolean

Example:

false

Response

string<uuid>

required

Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

emailAddress

string

required

Example:

"[email protected]"

firstName

string | null

required

Example:

"Jane"

lastName

string | null

required

Example:

"Doe"

displayName

string | null

required

Example:

"Jane Doe"

provider

string

required

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.

Example:

"custom"

status

enum<string>

required

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.

Available options:

active,

inactive,

checking,

revoked,

failed

maxEmailsPerDay

number

required

Daily CAMPAIGN send cap. Warmup is budgeted separately (warmup.maxPerDay).

Example:

30

sendingGapMinutes

number

required

Minimum minutes between two sends from this mailbox, across all campaigns.

Example:

10

campaignSlowRamp

boolean

required

Ramp campaign volume up gradually when the mailbox joins a campaign.

Example:

false

replyToAddress

string | null

required

Where replies are sent, when it differs from the mailbox address.

Example:

"[email protected]"

signature

string | null

required

HTML signature appended to outgoing emails.

Example:

"Best regards,<br>Jane"

bcc

string | null

required

Example:

"[email protected]"

automationLanguage

string

required

ISO 639-1 language for auto-generated content.

Example:

"en"

warmup

object

required

Show child attributes

tracking

object

required

Show child attributes

statusMessage

object | null

required

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.

Show child attributes

Lead Finder

Email Accounts

Campaigns

Emails

Leads

API Keys

Workspace

Analytics

Update a mailbox

Authorizations

Headers

Path Parameters

Body

Response