Skip to main content
POST
/
customer
Create Customer
curl --request POST \
  --url https://sandbox.flowwise.com/router/customer \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "customer_id": "cust_priya_sharma_2024",
  "scope": "PROJECT",
  "name": "Priya Sharma",
  "phone": "+919876543210",
  "email": "[email protected]",
  "address": "123 Connaught Place, New Delhi, Delhi 110001, India"
}
'
{
  "id": "cust_rec_67890",
  "added_on": "2024-12-01T10:30:00Z",
  "updated_on": "2024-12-03T14:15:30Z",
  "customer_id": "cust_priya_sharma_2024",
  "project_id": "proj_fashion_store_2024",
  "scope": "PROJECT",
  "status": "ACTIVE",
  "name": "Priya Sharma",
  "email": "[email protected]",
  "phone": "+919876543210",
  "address": "123 Connaught Place, New Delhi, Delhi 110001, India"
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Request parameters to create a new customer.

​
customer_id
string
required

Unique identifier for the customer.

Example:

"cust_priya_sharma_2024"

​
scope
enum<string>
required

Scope of the customer record (project-specific or global).

Available options:
PROJECT,
GLOBAL
Example:

"PROJECT"

​
name
string

Full name of the customer.

Example:

"Priya Sharma"

​
phone
string

Phone number of the customer.

Example:

"+919876543210"

​
email
string

Email address of the customer.

Example:

"[email protected]"

​
address
string

Address of the customer.

Example:

"123 Connaught Place, New Delhi, Delhi 110001, India"

Response

Success response for customer creation.

​
id
string

Internal system identifier for the customer record.

Example:

"cust_rec_67890"

​
added_on
string

Date and time when the customer was created.

Example:

"2024-12-01T10:30:00Z"

​
updated_on
string

Date and time when the customer was last updated.

Example:

"2024-12-03T14:15:30Z"

​
customer_id
string

Unique identifier for the customer.

Example:

"cust_priya_sharma_2024"

​
project_id
string

Identifier for the project associated with the customer.

Example:

"proj_fashion_store_2024"

​
scope
string

Scope of the customer record (project-specific or global).

Example:

"PROJECT"

​
status
string

Current status of the customer record.

Example:

"ACTIVE"

​
name
string

Full name of the customer.

Example:

"Priya Sharma"

​
email
string

Email address of the customer.

Example:

"[email protected]"

​
phone
string

Phone number of the customer.

Example:

"+919876543210"

​
address
string

Address of the customer.

Example:

"123 Connaught Place, New Delhi, Delhi 110001, India"