Skip to main content
POST
Create a salesperson

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
name
string
gerekli

Salesperson's name.

Maximum string length: 255
email
string<email>
gerekli

Salesperson's email address.

Maximum string length: 255
set_password
boolean | null

Whether an explicit password is provided. When false, a random password is generated and a reset link is sent.

password
string | null

Salesperson's password. Required when set_password is true.

Minimum string length: 8
password_confirmation
string | null

Salesperson's password confirmation. Must match the password field.

Minimum string length: 8
phone
string | null

Salesperson's phone number.

Maximum string length: 20
language
enum<string>[] | null

Salesperson's language preferences.

A language preference value.

Mevcut seçenekler:
Turkish,
English,
Other
avatar_url
string | null

Salesperson's avatar URL.

Maximum string length: 1000
is_active
boolean | null

Salesperson's active status.

active_lead_cap
integer | null

Maximum number of active leads the salesperson may hold at once. Ignored when is_lead_cap_unlimited is true.

Gerekli aralık: 0 <= x <= 100
is_lead_cap_unlimited
boolean | null

Whether the salesperson may hold an unlimited number of active leads. When true, active_lead_cap is not enforced.

treatment_ids
integer[] | null

An array of treatment IDs the salesperson handles.

A treatment ID.

Gerekli aralık: x >= 1
work_hours
object[] | null

The weekly working hours, exactly one row per day from monday to sunday.

Required array length: 7 elements

Yanıt

The response is of type object.