Create User

开发中

POST

/users

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.

请求参数

Header 参数

x-api-key

string

可选

API key of your funnel account.

示例值:

DmxPFlWX1H*Ag$IuHOaNKQwHp$JWa^l93oKuOpu4Xg5zYmWPER%#P34&LUwD!B!9

Body 参数application/json

funnel_page_id

string

可选

Funnel Page ID

name

string

必需

Full name of the user.

string

必需

Use email to create user

country_code

string

可选

mobile

string

可选

source

string

必需

add_tags

array [object {1}]

可选

value

string

可选

lang

string

必需

country_id

string

必需

示例

{
  "funnel_page_id": "658e77505c125ffdfd0ea886",
  "name": "Peter Chan",
  "email": "peter.chan7@gmail.com",
  "country_code": "852",
  "mobile": "98765499",
  "source": "FB",
  "lang": "tc",
  "country_id": "CR-HK",
  "add_tags": [
    {
      "value": "音樂"
    },
    {
      "value": "旅遊"
    },
    {
      "value": "跑步"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/users' \
--header 'x-api-key: DmxPFlWX1H*Ag$IuHOaNKQwHp$JWa^l93oKuOpu4Xg5zYmWPER%#P34&LUwD!B!9' \
--header 'Content-Type: application/json' \
--data-raw '{
  "funnel_page_id": "658e77505c125ffdfd0ea886",
  "name": "Peter Chan",
  "email": "peter.chan7@gmail.com",
  "country_code": "852",
  "mobile": "98765499",
  "source": "FB",
  "lang": "tc",
  "country_id": "CR-HK",
  "add_tags": [
    {
      "value": "音樂"
    },
    {
      "value": "旅遊"
    },
    {
      "value": "跑步"
    }
  ]
}'

返回响应

🟢200Success

application/json

Body

integer

可选

100 : User is successfully created
-1: Invalid API key
-100 : Missing fields
-200 : Incorrect format
-300 : Duplicate user - email has been used

string

可选

Return message in details

user_id

string

可选

User ID of newly created user

示例

{
    "rc": 100,
    "rm": "User is successfully created",
    "user_id": "63aadd3754bd917dxxxxxxxx"
}

Get User

Update User