サブメールアドレスの追加
メンバーのサブメールアドレスを追加します。最大で 10 個まで追加できます。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/email/aliases/{email}
HTTP Method
POST
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
externalKey | String | 100 字 | Y | メンバーの External Key |
String | 90字 | Y | サブメールアドレス ● localpart@domain 形式で記述。 ● localpart は 2~40 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)のみ使用可。 ● localpart の 1 文字目は英数字のみ可。 ● ドット(.)は localpart の最初と最後および連続使用(..)不可。 |
Request Example
POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/email/aliases/!test_123@example.com
Response
API 呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST API エラーコードを参照してください。