---
title: "Create domain-wide catch-all password"
method: POST
path: "/v1/domains/{domain_id}/catch-all-passwords"
tags: ["Domains"]
---

# Create domain-wide catch-all password

`POST /v1/domains/{domain_id}/catch-all-passwords`

## Request

- Base URL: `https://api.forwardemail.net`
- URL: `https://api.forwardemail.net/v1/domains/{domain_id}/catch-all-passwords`
- Auth: none declared

Creates a domain-wide catch-all password. If no password is provided, a secure random one will be generated. Catch-all passwords are for SMTP sending only. For IMAP, POP3, CalDAV, CardDAV, and mailbox access, generate a password for the specific alias instead.

## Path parameters

- `domain_id` string, required

## Request body

- object
  - `new_password` string: Your custom new password to use for the domain-wide catch-all password. Leave blank to generate a strong password. Custom mailbox passwords must be 128 characters or fewer, cannot start or end with whitespace, and cannot contain quotes or apostrophes. Catch-all passwords are for SMTP sending only. For IMAP, POP3, CalDAV, CardDAV, and mailbox access, generate a password for the specific alias instead.
  - `description` string: Description for organization purposes only.

## Response `200`

Successfully created a catch-all password

- object
  - `id` string, required: ID of the created catch-all password
  - `description` string, required: Description of the catch-all password

---

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