Create pod

Create a new pod (an isolated sub-account for one of your end users or tenants). Pass your own clientId to map the pod to a record in your system and address it later without storing the OpenMail ID.

POST /v1/pods

Create pod

cURL

curl --request POST \
  --url https://api.openmail.sh/v1/pods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "name": "<string>"
}
'

201

{
  "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

201

application/json

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>