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 '
{
  "externalId": "<string>",
  "username": "<string>"
}
'
{
  "id": "<string>",
  "address": "jsmith@example.com",
  "externalId": "<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
​
externalId
string

Your ID for this inbox (e.g. user ID)

​
username
string

Inbox local part (default: random)

Required string length: 3 - 30

Response

Inbox created

​
id
string

openmail inbox ID

​
address
string<email>

Full email address

​
externalId
string

Your external ID

​
createdAt
string<date-time>