Skip to main content
POST
/
v1
/
inboxes
Create inbox
curl --request POST \
  --url https://api.openmail.sh/v1/inboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mailboxName": "<string>",
  "displayName": "<string>",
  "domain": "<string>",
  "podId": "<string>"
}
'
{
  "id": "<string>",
  "podId": "<string>",
  "address": "jsmith@example.com",
  "displayName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
mailboxName
string

Inbox local part (default: random)

Required string length: 3 - 30
​
displayName
string

Sender display name shown in the From header

Maximum string length: 200
​
domain
string

Domain for the inbox address. Defaults to your account domain (e.g. openmail.sh). Pass a verified custom domain you own to create the inbox on it (e.g. agent-mail.example.com). The domain must already be added and verified for your account; the account default never switches automatically.

​
podId
string

Pod to create the inbox in. Accepts the pod ID or your own clientId. Omit to place the inbox in your account's default pod.

Response

Inbox created

​
id
string

OpenMail inbox ID

​
podId
string

ID of the pod this inbox belongs to. Inboxes created without an explicit pod land in your account's default pod.

​
address
string<email>

Full email address

​
displayName
string | null

Sender display name

​
createdAt
string<date-time>