Scheduler Zero
REST APIAPI referenceInboxes

Bulk-add IMAP/SMTP sending inboxes

Create multiple IMAP/SMTP (non-Google / non-Microsoft) sending inboxes in one call — e.g. AWS WorkMail mailboxes. Each account is created independently; the response reports per-account success/failure. `minIntervalMinutes` is the minimum gap between sends in MINUTES; `dailyLimit` is the per-inbox daily send cap. Passwords are encrypted at rest. Requires the `inbox:connect` permission.

POST
/inbox/imap-smtp/bulk-add

Create multiple IMAP/SMTP (non-Google / non-Microsoft) sending inboxes in one call — e.g. AWS WorkMail mailboxes. Each account is created independently; the response reports per-account success/failure. minIntervalMinutes is the minimum gap between sends in MINUTES; dailyLimit is the per-inbox daily send cap. Passwords are encrypted at rest. Requires the inbox:connect permission.

Authorization

ApiKeyAuth
x-api-key<token>

API key created under Settings → API Keys. Scoped to a single workspace.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/inbox/imap-smtp/bulk-add" \  -H "Content-Type: application/json" \  -d '{    "accounts": [      {        "emailAddress": "user@example.com",        "imapHost": "string",        "imapPort": 0,        "imapUsername": "string",        "imapPassword": "string",        "smtpHost": "string",        "smtpPort": 0,        "smtpUsername": "string",        "smtpPassword": "string"      }    ]  }'
{  "status": "success",  "created": 0,  "total": 0,  "results": [    {      "emailAddress": "user@example.com",      "ok": true,      "inboxId": "971631a1-925b-46c2-9319-20bd0956b313",      "error": "string"    }  ]}

Update a campaign's sending schedule PATCH

Requires the `campaign:update` permission.

Create Gmail connection links POST

Mint one or more Google authorization links for connecting Gmail / Google Workspace inboxes to this workspace. Adding a mailbox requires interactive Google consent, so this does NOT connect inboxes directly — it returns links a person must open in a browser where they are signed in to Scheduler Zero, choose the Gmail account, and approve access. Each link connects one Gmail account and expires in 2 hours. Requires the `inbox:connect` permission, and the person who opens a link must be a signed-in member of this workspace. The number of links is clamped to the workspace's remaining plan inbox allowance — compare `requested` vs `issued` to see if it was clamped (connecting beyond the plan limit is still possible from the app and is billed as overage).