create

POST

/v1/customers

curl --request POST \
  --url https://example.com/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "external_id": "example", "idempotency_key": "example", "metadata": "example", "name": "example", "phone": "example" }'

Authorizations

• bearer_auth

Request Body ^required

Media type application/json

object

email

string

nullable

external_id

string

nullable

idempotency_key

required

string

metadata

nullable

name

string

nullable

phone

string

nullable

Example ^generated

{
  "email": "example",
  "external_id": "example",
  "idempotency_key": "example",
  "metadata": "example",
  "name": "example",
  "phone": "example"
}

Responses

200

Customer created

Media type application/json

object

created_at

required

string format: date-time

deleted_at

string format: date-time

nullable

email

string

nullable

external_id

string

nullable

id

required

string format: uuid

idempotency_key

required

string

metadata

required

name

string

nullable

phone

string

nullable

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

Example ^generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "deleted_at": "2026-04-15T12:00:00Z",
  "email": "example",
  "external_id": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "idempotency_key": "example",
  "metadata": "example",
  "name": "example",
  "phone": "example",
  "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Invalid request

401

Unauthorized

403

Missing scope: customer:write