Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

Create a customer

For accountType: "business" a non-empty telephone is required — the console enforces it on every later edit of the contact.

POST/customer
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Request body
application/json
emailstringrequired

Customer email.

firstNamestringrequired

First name.

lastNamestringrequired

Last name.

accountTypestringrequired

Account type.

Allowed:businessprivate
telephonestring

Phone number. Required for business contacts.

companyNamestring

Company name.

departmentstring

Department.

billingAddressFieldsany[]

Billing addresses. Effectively required — omitting it currently fails with a 500 instead of a validation message.

deliveryAddressFieldsany[]

Delivery addresses.

Responses
200

Created. Returns only the id — fetch the full Customer with the corresponding GET.

idinteger | stringrequired

Id of the created Customer.

Show properties
One of:
integer
integer
string
string
401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/customer' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "accountType": "business",
  "telephone": "string",
  "companyName": "string",
  "department": "string",
  "billingAddressFields": [],
  "deliveryAddressFields": []
}'
Response
{
  "id": 0
}