Upsert a User (By memberId)

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

Parameter

Accessible via URL https://api.channel.io/open/v3/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

unsubscribed

true or false

Optional

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

Body

Example

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

Your PUT 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