Create customer (create-only)

post

https://customer-services.omni.chat/v1/customers

Creates a new customer record. Does not perform lookup or merge with existing customers.

Request body matches find-or-upsert fields (phone required); do not send retailerId in the body —
it is applied from the Lambda authorizer context only.

After creation, optional customFields are merged the same way as in find-or-upsert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Finds or creates a customer by phone number (required). If externalId is provided, the lookup
is performed first by it, then by phone and, optionally, by email.
When the customer already exists, the fields sent are updated. customFields is merged with existing
values. acceptsMarketing is sent as a string; only the literal "true" is persisted as boolean true.

Same payload shape is used for POST /v1/customers (create-only). Do not send retailerId in the JSON body for either endpoint — it comes from the Lambda authorizer.

phone

object

required

string

externalId

string

Customer external identifier in the retailer's system.

name

string

lastName

string

customFields

array of objects

customFields

acceptsMarketing

string

Use a string; only "true" is stored as boolean true in the backend.

birthDate

date

businessAccount

boolean

businessName

string

taxDocumentNumber

string

Customer tax document number (CPF or CNPJ).

address

object

gender

string

enum

Allowed:

Responses

200Customer created successfully.

400Bad request

401Unauthorized

403Forbidden

500Internal server error