Domains

Create domain-wide catch-all password

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.

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

Path parameters

domain_idstring required

The domain name to create the catch-all password for

Request body

new_passwordstring

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.

descriptionstring

Description for organization purposes only.

Response

Successfully created a catch-all password

idstring required

ID of the created catch-all password

descriptionstring required

Description of the catch-all password

Changes

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