Skip to main content
POST
Create a customer

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Gövde

application/json
first_name
string
gerekli

Customer's first name.

Maximum string length: 255
last_name
string
gerekli

Customer's last name.

Maximum string length: 255
phone_number
string
gerekli

Customer's phone number.

Maximum string length: 20
email
string<email> | null

Customer's email address.

Maximum string length: 255
date_of_birth
string<date-time> | null

Customer's date of birth.

gender
enum<string> | null

Customer's gender.

Mevcut seçenekler:
male,
female,
other,
null
country_id
integer | null

Customer's country identifier.

city_id
integer | null

Customer's city identifier. When country_id is provided, the city must belong to it.

district_id
integer | null

Customer's district identifier. When city_id is provided, the district must belong to it.

identity_number
string | null

Customer's identity number (11 digits, unique per tenant).

passport_number
string | null

Customer's passport number (6-12 uppercase letters and digits, unique per tenant).

Required string length: 6 - 12
Pattern: ^[A-Z0-9]+$
occupation_id
integer | null

Customer's occupation identifier. The occupation must be active and available to the tenant.

address
string | null

Customer's address.

Maximum string length: 1000
default_channel_id
integer | null

The customer's preferred default channel.

user_id
integer | null

Assigned user identifier.

tags
integer[] | null

Tag identifiers to attach to the customer.

A tag ID.

Yanıt

success
string
gerekli
data
CustomerResource · object
gerekli