Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Email aliases

Create email alias

Adds a new email alias to a user account..

post/users/{user_id}/email_aliases

Path parameters

user_idstring required

The ID of the user.

Request body

emailstring 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 request

{
  "email": "alias@example.com"
}

Response

Returns the newly created email alias object.

idstring

The unique identifier for this object.

type'email_alias'

The value will always be email_alias.

emailstring

The email address.

is_confirmedboolean

Whether the email address has been confirmed.

Example response

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