Клиенты

Поля клиента

Ключ

Тип

Описание

id

ObjectId

ID клиента

phone

str

Номер телефона клиента

name

str

Полное имя клиента

utm

Dict

UTM-метки клиента

first_name

Optional[str]

Имя клиента

last_name

Optional[str]

Фамилия клиента

middle_name

Optional[str]

Отчество клиента

email

Optional[str]

Адрес электронной почты клиента

sex

Optional[str]

Пол клиента

birthday

Optional[date]

День рождения клиента

tags

List[ClientTag]

Теги клиента

tags_hidden

List[ClientTag]

Скрытые теги клиента

code

Optional[str]

Код персональной карты клиента

description

Optional[str]

Комментарий к клиенту

Описание тегов клиента

Ключ

Тип

Описание

value

str

Значение тега

is_global

bool

Флаг глобального тега

Флаг is_global тега означает, что тег установлен франчайзером и не может быть изменен нижестоящими пользователями.

Скрытые теги видны только франчайзеру.

Примечание

При использовании франчайзинга каждый отдельный франчайзи видит только свои теги и теги франчайзера.

Список клиентов

Для получения списка всех клиентов необходимо использовать API GET /api/client

В GET-параметрах допустимо использование фильтров

Ключ

Тип

Описание

query

str

Свободный поиск клиента по имени и телефону

Просмотр клиента

Для получения данных о клиенте по его ID, необходимо использовать API GET /api/client/<client_id>.

Для получения клиента по полному совпадению номера телефона можно использовать эндпоинт GET /api/client/by-phone/<phone>

Предупреждение

Номер клиента хранится в формате E164. Для получения клиента по номеру рекомендуется передавать номера в этом же формате. Вне зависимости от пользовательского ввода, все номера нормализуются и при возможности приводятся к этому виду автоматически. Код страны по-умолчанию (в случае, если передан номер формата 89123456789) берется из настроек системы.

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

Для редактирование клиента необходимо использовать API PUT /api/client/<client_id>. На вход принимаются поля в том же формате, что возвращает метод просмотра клиента.