pods

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

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/pods
  • Auth: HTTP bearer

Request body

clientIdstring nullable

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.

namestring nullable

Human-readable label shown in the console.

Response

Pod created

idstring

OpenMail pod ID

clientIdstring nullable

Your own identifier for the pod, if set.

namestring nullable

Human-readable label, if set.

isDefaultboolean

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

createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.