Create Customer

Creates a customer and returns the full customer record (group nested under group).

Overview

See the Customers menu overview for the full feature flow.

All admin endpoints require an admin Bearer token — see Authentication.

Endpoint

Endpoint	Method
/api/admin/customers	POST

Request Body

Field	Type	Required	Description
first_name	string	yes
last_name	string	yes
email	string	yes	Unique.
phone	string	no
gender	enum	no	Male, Female, Other
date_of_birth	date	no
customer_group_id	integer	yes
channel_id	integer	no
status	integer	no	0 or 1 (default 1).
subscribed_to_news_letter	boolean	no
send_password	boolean	no	Default true — a random password is generated and the credentials are emailed to the customer. When false, explicit password is required.
password	string	conditional	Required when send_password=false; min 6 chars.

Permission

customers.customers.create