Перейти к содержимому

Редактирование клиента

PUT
/v1/client/{id}
curl --request PUT \
--url https://api-admin.billz.ai/v1/client/123 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01' \
--data '{ "date_of_birth": "2022-05-14", "first_name": "John", "gender": 1, "last_name": "Doe", "phone_number": [ "+998000000000" ] }'

Заменяет данные клиента целиком: поле, которого нет в теле, очищается. Передавайте все поля клиента, в том числе те, что не меняются.

phone_number заменяет список телефонов, а не дополняет его. Номера сохраняются как переданы — указывайте их в международном формате с +.

Ответ "success" не подтверждает, что клиент найден: для несуществующего id ответ тот же.

Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

id
required
string

Берётся из пути; значение из тела игнорируется

Example
123
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Media typeapplication/json
object
phone_number

Все номера телефона клиента; заменяют текущий список

Array<string>
first_name

Имя

string
last_name

Фамилия

string
gender

Пол числом

integer format: int32
date_of_birth

Дата рождения

string
chat_id

Telegram chat_id

string
Example
{
"date_of_birth": "2022-05-14",
"first_name": "John",
"gender": 1,
"last_name": "Doe",
"phone_number": [
"+998000000000"
]
}

Успешный ответ

Media typeapplication/json

Строка "success"

string
Example
success