ユーザー編集API

指定されたパラメーターでユーザー情報を更新する。

メソッド

POST

パス

/user/edit

リクエストボディ

Name	型	概要
tenant_id(必須)	文字列	テナントID ※別途お渡しした内容をご利用ください。
contents.user_id(必須)	文字列	更新対象のユーザーID 顧客番号といずれか必須
contents.user_no(必須)	文字列	更新対象の顧客番号 ユーザーIDといずれか必須
contents.update_date(必須)	文字列	変更前の更新日時（yyyy-mm-dd hh:mi:ss形式） ※他の処理によって、指定した日時より後にユーザーが更新されている場合、排他エラーになります。変更前の更新日時はユーザー情報取得APIなどで取得したユーザーのupdate_dateを参照してください。
contents.free_columns.smartphonesb_cd	文字列	プッシュサーバーの種別 FCM: 0001 APNs: 0002
contents.free_columns.push_device_token	文字列	プッシュ通知の送信先デバイストークン
contents.free_columns.{field_name}(必須)	文字列	その他、自由項目 ※未指定の項目は更新されません。

ヒント

contents.free_columns.{field_name}には name、age_configなどのユーザーの項目名を指定します。また、値を空に更新する場合は項目名に空文字を指定してください。

レスポンスボディ

Name	型	概要
status(必須)	文字列	ステータスコード
message(必須)	文字列	実行メッセージ
contents.success_message	文字列	更新完了メッセージ
contents.user_info	オブジェクト	更新したユーザー情報
contents.detail_message	文字列、配列	エラーメッセージ

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "success_message": "登録情報を更新しました。",
    "user_info": {
      "user_no": "APP00001",
      "user_id": "210010000000001",
      "user_name": "ピープルテスト",
      "age_config": "0001",
      "age_config_name": "10代",
      "update_date": "2024-01-01 00:00:00",
      "user_sample_image": "123456789.jpg",
      "user_sample_image_url": "https://test.raku-za.jp/apps/test/Image/users/123456789.jpg"
    }
  }
}