Skip to main content
POST
/
v2
/
customers
Create a new customer (v2)
curl --request POST \
  --url http://localhost:3156/v2/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "email": "[email protected]",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "notificationOptions": {
    "notifyEmail": false,
    "notifyPhone": false
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "phoneNumber": "+1234567890",
  "active": true,
  "notificationOptions": {
    "notifyEmail": true,
    "notifyPhone": false
  },
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z"
}

Body

application/json
​
firstName
string
required

Customer's first name

Example:

"John"

​
email
string<email>
required

Customer's email address

Example:

"[email protected]"

​
lastName
string

Customer's last name

Example:

"Doe"

​
phoneNumber
string

Customer's phone number

Example:

"+1234567890"

​
notificationOptions
object

Customer notification preferences

Response

Customer created successfully

​
id
string<uuid>

Unique customer identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
firstName
string

Customer's first name

Example:

"John"

​
lastName
string

Customer's last name

Example:

"Doe"

​
email
string<email>

Customer's email address

Example:

"[email protected]"

​
phoneNumber
string

Customer's phone number

Example:

"+1234567890"

​
active
boolean

Whether the customer is active

Example:

true

​
notificationOptions
object

Customer notification preferences

​
createdAt
string<date-time>

Customer creation timestamp

Example:

"2025-01-15T10:00:00.000Z"

​
updatedAt
string<date-time>

Customer last update timestamp

Example:

"2025-01-15T10:00:00.000Z"