Skip to main content
POST
/
users
/
{user_id}
/
email_aliases
cURL
curl -i -X POST "https://api.box.com/2.0/users/12345/email_aliases" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "email": "alias@example.com"
     }'
{
  "id": "11446498",
  "type": "email_alias",
  "email": "alias@example.com",
  "is_confirmed": true
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
user_id
string
required

The ID of the user.

Body

application/json
​
email
string
required

The email address to add to the account as an alias.

Note: The domain of the email alias needs to be registered to your enterprise. See the domain verification guide for steps to add a new domain.

Example:

"alias@example.com"

Response

Returns the newly created email alias object.

An email alias for a user.

​
id
string

The unique identifier for this object.

Example:

"11446498"

​
type
enum<string>

The value will always be email_alias.

Available options:
email_alias
Example:

"email_alias"

​
email
string

The email address.

Example:

"alias@example.com"

​
is_confirmed
boolean

Whether the email address has been confirmed.

Example:

true