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

    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"
         }'

    Response Example

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