ユーザー登録API
指定されたパラメーターでユーザーを登録する。
メソッド
POST
パス
/user/regist
リクエストボディ
Name | 型 | 概要 |
---|---|---|
tenant_id (必須) | 文字列 | テナントID ※別途お渡しした内容をご利用ください。 |
contents.mode (必須) | 文字列 | モード 登録チェックのみ実行: check 登録チェック後にユーザー登録: execute |
contents.event_no (必須) | 数値 | 顧客登録オブジェクトID201 固定 |
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.user_no | 文字列 | 登録したユーザーの顧客番号 |
contents.user_id | 文字列 | 登録したユーザーのユーザーID |
contents.user_info | オブジェクト | 登録したユーザー情報 |
contents.detail_message | 文字列、配列 | エラーメッセージ |
レスポンスの例
{
"status": "1001",
"message": "正常終了",
"contents": {
"user_no": "APP00001",
"user_id": "210010000000001",
"user_info": {
"user_no": "APP00001",
"user_id": "210010000000001",
"user_name": "ピープルテスト",
"age_config": "0001",
"age_config_name": "10代",
"join_dte": "2024-01-01",
"user_sample_image": "123456789.jpg",
"user_sample_image_url": "https://test.raku-za.jp/apps/test/Image/users/123456789.jpg",
"user_access_token": "JFAkQkV3RzM2XYZ1pcS5zelJocABcMmZJdklzay9jTXJoLw--"
}
}
}