特定のUser情報を更新できます。
URL https://api.channel.io/open/v5/users/{userId}およびHTTP PATCH経由でアクセス可能
PATCH本文にパラメータを表示します。この方法は現在application/jsonのみをサポートしています。
パラメータ | 例 | 要件 | 説明 | タイプ |
|---|---|---|---|---|
userId | 5ec3a01fe2b3f4d2cbc5 | 必須 | ID of | Path |
profile | {"name": "Gabrielle Chanel", ..} | 任意 | Profileオブジェクトにはユーザー情報が含まれます。 | Body |
profileOnce | {"utmSource": "google", ..} | 任意 | Profileオブジェクトにはユーザー情報が含まれます。ただし、プロパティが存在する場合は更新されません。 | Body |
tags | ['tag1', 'tag2'] | 任意 | ユーザーのタグ属性。既存のタグはすべて、新しく指定された配列に置き換えられます（上書きされます）。 | Body |
unsubscribeEmail | true or false | 任意 | このプロパティがtrueに設定されている場合、マーケティングメールは送信されません。 | Body |
unsubscribeTexting | true or false | 任意 | このプロパティがtrueに設定されている場合、マーケティングSMSは送信されません。 |
|
PATCH https://api.channel.io/open/v5/users/5ec3a01fe2b3f4d2cbc5
PATCHの本文は次のようになります。
JSON
変更されたUserオブジェクトを返します。
JSON
成功した場合、HTTPステータスコード200を返します。