---
title: "Create pod"
method: POST
path: "/v1/pods"
tags: ["pods"]
---

# Create pod

`POST /v1/pods`

## Request

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

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.

## Request body

- object
  - `clientId` string, 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.
  - `name` string, nullable: Human-readable label shown in the console.

## Response `201`

Pod created

- Pod
  - `id` string: OpenMail pod ID
  - `clientId` string, nullable: Your own identifier for the pod, if set.
  - `name` string, nullable: 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

## Other responses

- `409`: A pod with the same `clientId` already exists in your account

---

[API](https://skmtc.dev/openmail/apis/openmail-api.md) · [All operations](https://skmtc.dev/openmail/apis/openmail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openmail/apis/openmail-api/revisions/b943eecca7e2?raw)
