Create User

POST

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

Create a user within the funnel system.
Each user is identified by either his email or mobile. If the user already exists in database, the system will not allow to add.

Request

Body Params application/json

name

string

optional

Full name of the user.

firstname

string

optional

First name of the user.

lastname

string

optional

Last name of the user.

string

optional

Email of the user, either email or mobile must be provided.

country_code

string

optional

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

mobile

string

optional

Mobile of the user, either email or mobile must be provided.

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

add_to_tas

array [object {1}]

optional

Add this user to which lists (target audience).

ta_id

string

optional

TA ID, ID of target audience (受眾包)

Example

// Example 1 – Add user with fullname, email, source, tags and assign to target audience (受眾包) 
{
    "name": "Peter Chan",
    "email": peter.chan7@gmail.com,
    "source": "FB",
    "add_tags": [
        {
            "value": "音樂"
        },
        {
            "value": "旅遊"
        },
        {
            "value": "跑步"
        }
    ],
    "add_to_tas": [
        {
            "ta_id": "65d546e50d23ae244f0860e0"
        }

}

// Example 2 – Add user with firstname, lastname
{
    "funnel_page_id": "64f5313f35e6a55c52d1fcb",
    "firstname": "Peter Chan",
    "lastname": " Chan",
    "country_code": "852",
    "mobile": "98765432"
}

Responses

🟢200Success

application/json

Body

integer

required

100 : Success create
-100 : Missing fields
-200 : Incorrect format
-300 : Duplicate user
-400 : Fields not found

string

required

Return message in details

user_id

string

optional

User ID of newly created user

Examples

SuccessError

{
  "rc": 100,
  "rm": "User has successfully been created",
  "user_id": "63aadd3754bd917du93l2w"
}

Modified at 2024-04-04 04:31:34

Get User ID

Update User