Create User

POST

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

Add a user to a particular page of a funnel, in order to join an event or signup for a campaign.
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

funnel_page_id

string

required

The form that this user is adding to.

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.

Example

// Example 1 – Add to join a particular form with full name and source
{
    "funnel_page_id": "64f5313f35e6a55c52d1fcb",
    "name": "Peter Chan",
    "email": peter.chan7@gmail.com,
    "source": "FB"
 
}

// Example 2 – Add to join a particular form with firstname and 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

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:32:06

Get User (Coming Soon)