メンバー招待メールの再送
ステータスが「登録待ち」のメンバーに対し、招待メールを再送します。再送メールの招待者は、最高管理者になります。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API_ID}/organization/v2/domains/{domainId}/users/{externalKey}/resend/invitation
HTTP Method
POST(Content-Type: application/json; charset=UTF-8)
Path parameters
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
domainId | Integer | Y | ドメイン ID |
externalKey | String | Y | 原職アカウントの ExternalKey(最大 100 字) ● テナント内でユニークでなければなりません ● 特殊文字 % \ は使えません |
Request Body
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
useSavedPrivateEmail | Boolean | Y | 保存されている個人メールアドレスへの再送信有無。 true の場合は保存されている個人メール宛てに送信します。 |
|
String | N | useSavedPrivateEmail 値が false の場合は email 値が必須。 |
Request Example
POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/resend/invitation
{
"useSavedPrivateEmail" : false,
"email" : "aa@example.com"
}
Response
API 呼び出しに成功すると HTTP 200 コードを返します。
Error code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。