Update a User
Update information of a particular user.
Parameter
Accessible via URL https://api.channel.io/open/v3/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 |
unsubscribed | true or false | Optional | When this property is set to true, no marketing message will be sent. | Body |
Example
PATCH https://api.channel.io/open/v3/users/5ec3a01fe2b3f4d2cbc5
Your PATCH body should look like below
{
"profile": {
"name": "test",
"mobileNumber": "+821000000000",
"property1": "value",
"property2": 123
},
"profileOnce": {},
"tags": ['tag1', 'tag2'],
"unsubscribed": false
}
Response
Return HTTP status code 200
if succeed
Updated over 1 year ago