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

ユーザーのサブメールアドレスを登録する。
最大 10 個まで登録できる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

user
directory

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

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

サブメールアドレス (URL エンコードする)
localpart@domain の場合の localpart の制限

  • 2 ～ 40 字の英小文字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
  • 最初の文字には英小文字、数字のみ使用できる
  • ドット (".") は最初と最後、および連続 ("..") では使用できない

required
maxLength : 90
example : alias@example.com 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 201

OK

PropertyTypeDescription
aliasEmails array (string) 

サブメールアドレスリスト

 

Response Example

example

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

HTTP 400

Bad Request

HTTP 404

Not Found