Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://api.juo.io/admin/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "tags": [
    "<string>"
  ],
  "note": "<string>"
}
'
{
  "id": "7654321",
  "resource": "customer",
  "displayName": "Jane Smith",
  "email": "[email protected]",
  "phone": "+15550100"
}

Authorizations

​
X-Juo-Admin-Api-Key
string
header
required

Long-lived Admin API key issued from the Juo merchant portal. Pass as the X-Juo-Admin-Api-Key header.

Headers

​
X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Body

application/json
​
firstName
string
​
lastName
string
​
email
string<email>
​
phone
string
​
tags
string[]
​
note
string

Response

Default Response

​
id
string
required

Customer ID (numeric string).

Minimum string length: 1
Example:

"7654321"

​
resource
enum<string>
required
Available options:
customer
​
displayName
string
required

Customer's full name.

Minimum string length: 1
Example:

"Jane Smith"

​
email
null | string<email>
required

Customer's contact email.

Example:

"[email protected]"

​
phone
null | string
required

Customer's contact phone number in E.164 format.

Minimum string length: 1
Example:

"+15550100"