Channel Developers

thumbnail

Upsert a User (By memberId))

Userが存在する場合は、情報を更新します。 そうでない場合は、新しいUserを作成します。

URL https://api.channel.io/open/v5/users/@{memberId}およびHTTP PUT経由でアクセス可能

memberIdの先頭に@が付く点にご注意ください。

PUT本文にパラメータを表示します。この方法は現在application/jsonのみをサポートしています。

パラメータ

要件

説明

タイプ

memberId

12345

必須

自社で使用しているメンバー(ユーザー)ID

Path

profile

{"name": "Gabrielle Chanel", ..}

任意

Profileオブジェクトにはユーザー情報が含まれます。

Body

profileOnce

{"utmSource": "google", ..}

任意

Profileオブジェクトにはユーザー情報が含まれます。ただし、プロパティが存在する場合は更新されません。

Body

tags

['tag1', 'tag2']

任意

ユーザーのタグ属性です。既存のタグはすべて、新しく指定された配列に置き換えられます。

Body

unsubscribeEmail

true or false

任意

このプロパティがtrueに設定されている場合、マーケティングSMSは送信されません。

Body

unsubscribeTexting

true or false

任意

このプロパティがtrueに設定されている場合、マーケティングSMSは送信されません。

PUT https://api.channel.io/open/v5/users/@12345

PUTの本文は次のようになります。

JSON

デフォルトのレスポンス:

JSON