Skip to main content
POST
/
v1
/
pods
Create pod
curl --request POST \
  --url https://api.openmail.sh/v1/pods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "name": "<string>"
}
'
{
  "id": "<string>",
  "clientId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "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
​
clientId
string | null

Your own stable identifier for this pod (e.g. your user/tenant ID). Must be unique within your account. Use it in place of the pod ID on any pod or inbox endpoint.

Maximum string length: 255
​
name
string | null

Human-readable label shown in the console.

Maximum string length: 255

Response

Pod created

​
id
string

OpenMail pod ID

​
clientId
string | null

Your own identifier for the pod, if set.

​
name
string | null

Human-readable label, if set.

​
isDefault
boolean

Whether this is the account's default pod. Every account has exactly one; it is created automatically and cannot be deleted.

​
createdAt
string<date-time>