Skip to main content
POST
/
customers
/
create
cURL
curl --request POST \
  --url https://api.olimi.ai/customers/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_list_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "email": "jsmith@example.com",
  "gender": "<string>"
}'
{
  "message": "Customer created successfully."
}
Creates a new customer in the specified customer list by providing necessary details such as name, phone number, email, and gender.

​
Request Example

{
  "customer_list_id": "string",
  "last_name": "string",
  "phone_number": "string",
  "email": "string",
  "gender": "string"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The customer details, including name, phone number, email, and gender.

​
customer_list_id
string
required

CustomerList ID where the customer is being added.

​
first_name
string
required

First name of the customer.

​
last_name
string
required

Last name of the customer.

​
phone_number
string
required

Phone number of the customer.

​
email
string<email>
required

Email address of the customer.

​
gender
string
required

Gender of the customer.

Response

Customer created successfully.

​
message
string
Example:

"Customer created successfully."

⌘I