Create Email Address
Creates a mailbox on one of the account’s domains. The domain needs the email capability in the ready state. Give it to a team member with user_id, or leave it out to share the mailbox with the account. Creating an address this account deleted brings the mailbox back, with its mail and a new password.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-15-1"
Body
The full address, such as support@example.com. The part before the @ can use letters, numbers, dots, dashes, underscores and plus signs.
"marcus@shinetime.example"
Account ID, prefixed biz_. Required for user credentials; otherwise defaults to the credential's account.
ID of the team member who owns the mailbox, prefixed user_. Only they can read it or send from it. Leave it out, or pass null, to share the mailbox with the account. Giving an owned mailbox to someone else empties it: the owner's mail is never shown to anyone else.
"user_xxxxxxxxxxxxxx"
Response
Email address created
ID of the account the address belongs to, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
The full address in lowercase, such as support@example.com.
"marcus@shinetime.example"
When the address was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
ID of the domain the address is on, prefixed dom_.
"whopappdomain0000001"
Email address ID, prefixed emaddr_.
"emaddr_xxxxxxxxxxxxxx"
The password mail apps sign in to the mailbox with over IMAP and SMTP, using the address as the username. null unless you can use the mailbox: you own it, or nobody owns it and you have email:read and email:send.
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
When the address was last updated, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
ID of the team member who owns the mailbox, prefixed user_. Only they can read it or send from it. null when the whole account shares it.
"user_xxxxxxxxxxxxxx"

