Channel Developers

thumbnail

Upsert a User (By memberId)

If a User exists, update information. If it's not, create a new User.

Accessible via URL https://api.channel.io/open/v5/users/@{memberId} and HTTP PUT

Note that there is @ character in front of memberId

Present parameters in PUT body. This method does currently accept application/json only.

Parameter

Example

Required

Description

Parameter type

memberId

12345

Required

member (user) identification id used by your company

Path

profile

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

Optional

Profile object contains user information

Body

profileOnce

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

Optional

Profile object contains user information. But, do not update if property is present

Body

tags

['tag1', 'tag2']

Optional

User's tag attribute . Replace all of them with the newly given array.

Body

unsubscribeEmail

true or false

Optional

When this property is set to true, no marketing email will be sent.

Body

unsubscribeTexting

true or false

Optional

When this property is set to true, no marketing email will be sent.

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

Your PUT body should look like below

JSON

default response

JSON