Create an email inbox
POST/api/v1/emailInbox
Claims a new email address and returns the inbox. The address must be on a domain this account can receive at, and is immutable once created. Requires API key with email_inboxes:create scope. The inbox is always created in the organization the key is bound to — there is no way to name a different one.
Request
Responses
- 201
- 400
- 401
- 403
- 409
- 422
Inbox created
Bad request - malformed JSON, the address is not a valid email address, the domain is not one this account may create inboxes at, the local part is longer than 50 characters, or the name is not a string or is longer than 100 characters.
Unauthorized - missing or invalid API key
Forbidden - API key lacks the email_inboxes:create scope
Conflict - the address is not available. Returned identically whether it is held by another organization or by a deleted inbox, so this endpoint cannot be used to probe which addresses exist.
Unprocessable - the address or the name is on the impersonation blocklist, or the name contains characters outside printable ASCII. A disallowed domain is a 400, not this.