Skip to main content

Adds an email alias for a user

POST/v2/users/:id_or_email/emailAliases

Adds an email alias for a specified user. The target user can be identified by user ID or primary email address.

Request​

Path parameters

    id_or_email stringrequired
    • id:
    • email:

Body parameters

    alias string
    asDefault boolean

    Whether to use it as the default display alias.

Response

No response fieldsA successful response contains no documented fields.

Errors

400Bad Request
401

Access is unauthorized. Please check whether the correct authorization token is passed.

403

No API access permission. Please complete the relevant authorization on the application management page of the domain administrator.

404Not Found