Update information of a particular User.
Accessible via URL https://api.channel.io/open/v5/users/{userId} and HTTP PATCH
Present parameters in PATCH body. This method does currently accept application/json only.
Parameter | Example | Required | Description | Parameter type |
|---|---|---|---|---|
userId | 5ec3a01fe2b3f4d2cbc5 | Required | ID of | 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 SMS will be sent. |
|
PATCH https://api.channel.io/open/v5/users/5ec3a01fe2b3f4d2cbc5
Your PATCH body should look like below
Returns the changed User object
Return HTTP status code 200 if succeed