POST/users/{userId}/alias-emails/{email}

Adds a member's email aliases. You can add up to 10 email aliases.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/alias-emails/{email}

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 
email string 

Email alias
* The format is localpart@domain.
* The localpart must start with a lowercase English letter or a number.
* The localpart cannot start or end with a dot (.) and cannot contain two or more consecutive dots.
* The localpart can be between 2 and 40 characters long and can only contain lowercase English letters, numbers, dot (.), hyphen (-), and underscore (_).


required
maxLength : 90
example : alias@example.com 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 201

OK

PropertyTypeDescription
aliasEmails array (string) 

List of email aliases

 

Response Example

example

1{2  "aliasEmails": [3    "alias@example.com",4    "alias1@example.com"5  ]6}

HTTP 400

Bad Request

HTTP 404

Not Found