Update User

POST

https://api.main.xleadfunnel.com/v1/account-users/update-user

Update a particular user with User ID, if fields are provided, system will update those fields based on the values you provided. If fields are not provied, system will not amend those field values that already existed in database.

Request

Body Params application/json

user_id

string

required

name

string

optional

Full name of the user.

string

optional

Email of the user.

country_code

string

optional

The country code and mobile number are paired as a unique identifier.

mobile

string

optional

Mobile of the user.

source

string

optional

Record the source or medium from which the user originates.

add_tags

array [object {1}]

optional

Add tags to this user.

value

string

optional

delete_tags

array [object {1}]

optional

Delete tags from this user.

value

string

optional

add_to_tas

array [object {1}]

optional

Add this user to particular target audience

ta_id

string

optional

delete_from_tas

array [object {1}]

optional

Delete this user from particular target audience

ta_id

string

optional

Example

{
  "name": "Peter Chan",
  "email": "peter.chan@gmail.com",
  "country_code": "852",
  "mobile": "98765432",
  "source": "FB",
  "add_tags": [
    {
      "value": "健身"
    }
  ],
  "delete_tags": [
    {
      "value": "跑步"
    }
  ]
}

Responses

🟢200Success

application/json

Body

integer

required

100 : Success update
-100 : No such user

string

required

Return message in details

Examples

SuccessError

{
  "rc": 100,
  "rm": "User has been successfully updated."
}

Create User

Delete User