開発者向け機能：API機能：ユーザ操作：ユーザ更新 – Shelter

ユーザレコード更新APIの機能仕様です。
APIを使用してレコードを更新する事ができます。

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。

■制限事項
「ROBOT ID」をご利用の場合、ユーザの更新は「ROBOT ID」側で行ってください。

■リクエスト
下記のリクエスト形式で、jsonデータを送信します。

＜設定項目＞

設定項目	値
HTTPメソッド	POST
Content-Type	application/json
文字コード	UTF-8
URL	https://ks01.shelterdb.net/api/users/{ユーザId}/update
Body	以下のjsonデータを参考のこと

＜jsonデータ＞

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "Name" : "[更新後のユーザーの名前]",
    "MailAddresses": [
        "webmaster@example.com",
        "info@example.com"
    ]
}

※メールアドレスを更新する場合はMailAddressesにリスト形式で記述します（任意）。
１つのユーザに対して単一または複数のメールアドレスを設定することが可能です。洗い替え方式で更新されます（古いメールアドレス情報を削除して新しいメールアドレス情報を追加する）。

■レスポンス
下記の形式のjsonデータが返却されます。

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\" ユーザーの名前を更新 \" を更新しました。"
}

■メールアドレスの設定について
以下のようにMailAddressesのパラメータを指定した上でリストを空にした場合はメールアドレスが削除されます。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "Name" : "[更新後のユーザーの名前]",
    "MailAddresses": [
    ]
}

以下のようにMailAddressesのパラメータを指定しない場合はメールアドレスは更新（削除）されません。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "Name" : "[更新後のユーザーの名前]"
}