MailboxesOperation mailboxes.create

Connect a mailbox

Connect a mailbox (SMTP and IMAP, sealed at rest).

POST/api/v1/mailboxes

Scope admin: Provider keys, developer keys, mailboxes, domains, settings, fixed costs.

Parameters

Body

A JSON object. Fields not listed are ignored.

Name	In	Description
`email`required	body	Address.
`display_name`	body	From name.
`smtp_host`required	body	SMTP host.
`smtp_port`	body, integer	SMTP port.
`imap_host`required	body	IMAP host.
`imap_port`	body, integer	IMAP port.
`username`required	body	Login.
`password`required	body	App password.
`daily_limit`	body, integer	Sends per day.

Example

curl

curl -X POST "https://crm.ashwanth.dev/api/v1/mailboxes" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "",
  "smtp_host": "",
  "imap_host": "",
  "username": "",
  "password": "",
  "display_name": "",
  "smtp_port": 0,
  "imap_port": 0,
  "daily_limit": 0
}'

CLI

sales-engine mailboxes create --email "..." --smtp-host "..." --imap-host "..."

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Body (JSON)

Every documented field is listed above; leave out the ones you do not need.

Request

POST /api/v1/mailboxes