Box Developer Documentation
Latest version

Create email alias

post
https://api.box.com/2.0
/users/:user_id/email_aliases

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Adds a new email alias to a user account..

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the user.

Request Body

stringin bodyrequired
"alias@example.com"

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.

Response

application/jsonEmail alias

Returns the newly created email alias object.

application/jsonClient error

An unexpected client error.

post
Create email alias
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


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"
     }'
Node/TypeScript v10
await client.emailAliases.createUserEmailAlias(newUser.id, {
  email: newAliasEmail,
} satisfies CreateUserEmailAliasRequestBody);
Python v10
client.email_aliases.create_user_email_alias(new_user.id, new_alias_email)
.NET v10
await client.EmailAliases.CreateUserEmailAliasAsync(userId: newUser.Id, requestBody: new CreateUserEmailAliasRequestBody(email: newAliasEmail));
Swift v10
try await client.emailAliases.createUserEmailAlias(userId: newUser.id, requestBody: CreateUserEmailAliasRequestBody(email: newAliasEmail))
Java v10
client.getEmailAliases().createUserEmailAlias(newUser.getId(), new CreateUserEmailAliasRequestBody(newAliasEmail))
Java v4
BoxUser user = new BoxUser(api, "0");
user.addEmailAlias("user+alias@example.com");
Python v3
user_id = '33333'
user = client.user(user_id)
email_alias = user.add_email_alias('alias@example.com')
.NET v5
BoxEmailAlias alias = await client.UsersManager
    .AddEmailAliasAsync(userId: "33333", email: "user+foo@example.com");
Node v3
client.users.addEmailAlias('33333', 'user+baz@example.com')
    .then(alias => {
        /* alias -> {
            type: 'email_alias',
            id: '12345',
            is_confirmed: false,
            email: 'user+baz@example.com' }
        */
    });

Response Example

{
  "id": "11446498",
  "type": "email_alias",
  "email": "alias@example.com",
  "is_confirmed": true
}