Начало работы

Пользовательские атрибуты

Как получить через API и вебхуки поля, которые аккаунт добавил в карточку клиента и в запись, и как передать их при создании записи.

Пользовательские атрибуты — это поля, которые аккаунт добавляет к карточке клиента или к записи сверх стандартных: например, «Канал связи» у клиента или «Номер в CRM» у записи. Атрибуты настраиваются в разделе Настройки → Данные → Пользовательские атрибуты. У каждого атрибута есть постоянный ключ slug: атрибуты клиента начинаются с customer_, атрибуты записи — с booking_.

Получение через API

Атрибуты возвращаются в поле custom_fields:

  • GET /customers/{uuid} — атрибуты карточки клиента;
  • полная запись (GET /bookings/{uuid}, а также ответы на создание и изменение записи) — атрибуты записи в custom_fields и атрибуты клиента в customer.custom_fields.

Списки GET /customers и GET /bookings атрибуты не содержат: чтобы получить их, запросите клиента или запись по uuid.

Фрагмент ответа GET /bookings/{uuid}:

{
  "uuid": "0641062b-b28c-4f63-8569-36c2a7dd8740",
  "start_time": "2026-11-11T07:00:00Z",
  "custom_fields": [
    { "slug": "booking_nomer_v_crm", "name": "Номер в CRM", "value": "CRM-1042" }
  ],
  "customer": {
    "uuid": "dc9772d0-4ee7-4a37-9701-4108ac6a5250",
    "first_name": "Анастасия",
    "last_name": "Соколова",
    "custom_fields": [
      { "slug": "customer_liubimyi_napitok", "name": "Любимый напиток", "value": "Капучино без сахара" },
      { "slug": "customer_kanal_sviazi", "name": "Канал связи", "value": "Telegram" }
    ]
  }
}
ПолеОписание
slugПостоянный ключ атрибута. Используйте его для сопоставления с полями вашей системы: название атрибута в панели можно изменить, а slug при этом не меняется.
nameНазвание атрибута на языке аккаунта.
valueЗначение. Для атрибута-списка возвращается название выбранного варианта, для скрытого атрибута без значения — значение по умолчанию. Если атрибут не заполнен, возвращается null.

В custom_fields перечислены все пользовательские атрибуты аккаунта, включая незаполненные. Стандартные поля формы (имя, телефон, почта, комментарий, внутренняя заметка к записи) в custom_fields не входят.

GET /customers/{uuid} всегда возвращает актуальные данные карточки, в том числе изменения, сделанные сотрудником в панели.

Передача при создании записи

В POST /bookings атрибуты передаются на верхнем уровне тела запроса, ключом служит slug:

{ "reserved_on": "2026-11-11T07:00:00Z",
  "location_uuid": "1ed7fb3d-…", "service_uuid": "099fa474-…", "staffer_uuid": "7a561987-…",
  "customer_phone": "+79150010203", "customer_first_name": "Анастасия", "customer_last_name": "Соколова",
  "booking_nomer_v_crm": "CRM-1042" }

Для атрибута-списка передаётся ключ варианта.

API принимает только атрибуты, добавленные в форму записи в разделе Настройки → Онлайн-запись → Конструктор форм; остальные ключи не сохраняются. Если клиент с таким телефоном уже есть, пустой атрибут в его карточке заполняется, а заполненный заменяется новым значением, только если в настройках поля формы включён параметр «Перезаписывать значение при записи».

POST /customers и PUT /customers/{uuid} пользовательские атрибуты не принимают.

Получение через вебхуки

В данных вебхуков записи атрибуты передаются отдельными полями customer_attributes.<slug> и booking_attributes.<slug>, например "booking_attributes.booking_nomer_v_crm": "CRM-1042" и "customer_attributes.customer_kanal_sviazi": "Telegram". Значения формируются по тем же правилам, что и value в API, но вместо null передаётся пустая строка. Подробнее — в статье Данные вебхука.

Читайте также

Copyright © 2026