Email Inboxes

Create an email inbox

Changed on

Creates an inbox on an inbound-enabled domain. When domain_id is omitted, Telnyx allocates the account's shared inbound subdomain so the inbox is immediately usable without customer DNS setup. When username is omitted, a unique username is generated.

post/email_inboxes

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_inboxes
  • Auth: HTTP bearer

Request body

usernamestring

Inbox local part. Trimmed and lowercased before validation; the normalized value must be 1-64 characters, start and end with a letter or digit, and contain only letters, digits, dots, hyphens, and underscores. Generated when omitted.

domain_idstring uuid

Account-owned, inbound-enabled domain UUID. The account's shared inbound subdomain is allocated when omitted.

Response

Email inbox created.

Changes

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

  • 2fb3b617430aRevision changes
    • info

      endpoint added