関係者連絡先の設定
メンバーを、他のメンバーの関係者連絡先に設定します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/relations
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| domainId | Integer | Y | ドメイン ID | |
| externalKey | String | 100 字 | Y | 関係付けるメンバーの External Key |
Request Parameters
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| relations[] | List | 10 | N | 関係者を登録するメンバー |
| relations[].externalKey | String | 100bytes | Y | 関係者の External Key |
| relations[].relationName | String | 50 字 | Y | 関係性 |
Request Example
POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/relations
{
"relations": [
{
"externalKey": "EX124",
"relationName": "秘書"
}
]
}
Response
API 呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。