Skip to Content
Alienmail Docs
Mailboxes

Update a mailbox

PATCH
/mailboxes/{id}

Changes a mailbox's sender name, its daily sending limit, or turns it off and on. Only what you send changes. Server settings, logins and passwords can't be changed through the API: reconnect the mailbox in Alienmail.

Requires the SMTP_UPDATE permission.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key of your workspace, from Workspace settings, Integrations. Each key has a role, and the role decides which endpoints it may call.

Path Parameters

id*integer

The mailbox id, from the mailbox list.

Request Body

application/json
  1. body
name?string

The sender name recipients see.

Length1 <= length <= 191
dailyLimit?integer

Most emails this mailbox sends per day, 1 to 2000.

Range1 <= value <= 2000
active?boolean

false stops sending from this mailbox; true turns it back on.

Response Body

The updated mailbox.

application/json
  1. response
id*integer

The mailbox id.

email*string

The address it sends from.

name*string

The sender name recipients see.

provider*string

How the mailbox is connected.

Value in"smtp""google""microsoft""outlook"
active*boolean

Whether campaigns may send from it.

connected*boolean

false when the last connection check failed. Reconnect it in Alienmail.

rateLimited*boolean

The mail provider is throttling this mailbox.

dailyLimit*integer

Most emails it sends per day, 1 to 2000.

sentToday*integer

Emails counted against the daily limit so far.

createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://app.alienmail.io/api/v1/mailboxes/7' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": 7,  "email": "ada@analyticalengines.com",  "name": "Ada from Analytical Engines",  "provider": "google",  "active": true,  "connected": true,  "rateLimited": false,  "dailyLimit": 50,  "sentToday": 12,  "createdAt": "2026-11-13T09:30:00.000Z",  "updatedAt": "2026-11-13T09:30:00.000Z"}