---
title: "Update pod"
method: PATCH
path: "/v1/pods/{id}"
tags: ["pods"]
---

# Update pod

`PATCH /v1/pods/{id}`

## Request

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

Update a pod's `clientId` or `name`. Only the fields you include are changed.

## Path parameters

- `id` string, required

## Request body

- object
  - `clientId` string, nullable: Your own identifier for this pod. Set null to clear.
  - `name` string, nullable: Human-readable label. Set null to clear.

## Response `200`

Pod updated

- 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

- `403`: The authenticating key is pod-scoped and cannot modify pods
- `404`: Not found
- `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)