Skip to content

Create Customer

Endpoint

EndpointMethod
/api/admin/customersPOST

Request Body

FieldTypeRequiredDescription
first_namestringyes
last_namestringyes
emailstringyesUnique.
phonestringno
genderenumnoMale, Female, Other
date_of_birthdateno
customer_group_idintegeryes
channel_idintegerno
statusintegerno0 or 1 (default 1).
subscribed_to_news_letterbooleanno
send_passwordbooleannoDefault true. When false, explicit password is required.
passwordstringconditionalRequired when send_password=false; min 6 chars.

Events

Fires customer.registration.before/after + customer.create.before/after.

Permission

customers.customers.create

Released under the MIT License.