ユーザー属性の更新

API を通じてユーザー属性の値を一括更新することが可能です。
開発者はビジネス要件に応じて柔軟にユーザー属性を設定でき、より適切なユーザー分析やレコメンデーションに活用できます。

リクエストメソッド

POST

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/property/update

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/property/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "example_user_id", "property_values": [ { "property_name": "example_property_name", "value": "example_value" } ] }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/property/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "user_id": "example_user_id",
    "property_values": [
        {
            "property_name": "example_property_name",
            "value": "example_value"
        }
    ]
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json` を設定してください。

リクエストボディ

パラメータ	タイプ	説明	必須
user_id	String	属性を設定する対象のユーザーID	必須
property_values	List	更新する属性のリスト	必須
property_values.property_name	String	属性名	必須
property_values.value	Object	属性値	必須

レスポンス

パラメータ	タイプ	説明
success_update	List	更新に成功したユーザー属性のリスト
success_update.propertyName	String	更新に成功した属性名
success_update.value	Object	更新に成功した属性の値
fail_update	List	更新に失敗したユーザー属性のリスト
fail_update.value	Object	更新に失敗した値
fail_update.property_name	String	更新に失敗した属性名