Skip to main content

​
Заголовки запроса

​
Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
​
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
​
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

​
Параметры запроса

​
mode
enum
required
Режим макета формы. Определяет где и как будет использоваться форма.Возможные значения:
  • Custom — кастомные поля пользователя
  • Form — заполняемая форма (анкета)
  • Signup — форма при регистрации (уникальная для школы)
  • Welcome — приветственная форма (уникальная для школы)
  • Participant — форма участника продукта
​
name
string
required
Название макета формы. Максимум 255 символов.
​
internalName
string
required
Внутреннее название макета. Максимум 255 символов. Используется для идентификации макета в интерфейсе управления.
​
status
enum
Статус макета. Возможные значения: Draft, Published. По умолчанию Draft.
​
slug
string
Символьный код макета. От 1 до 50 символов. Должен быть уникальным в рамках школы.
​
note
string
Заметка к макету. Максимум 255 символов.
​
productIds
integer[]
Массив ID продуктов, к которым привязан макет.
​
config
object
Настройки макета.
Для режимов Signup и Welcome допускается только один макет на школу. При попытке создать второй — существующий макет будет обновлён.
curl --location 'https://api.exode.biz/saas/v2/form/layout/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "mode": "Custom",
    "name": "Доп. данные клиента",
    "internalName": "CRM доп. поля",
    "status": "Published",
    "slug": "client-extra",
    "note": "Дополнительные поля для CRM",
    "config": {
      "resubmitMode": "Overwrite"
    }
  }'

{
  "success": true,
  "code": 200,
  "payload": {
    "id": 5,
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "mode": "Custom",
    "status": "Published",
    "slug": "client-extra",
    "name": "Доп. данные клиента",
    "internalName": "CRM доп. поля",
    "note": "Дополнительные поля для CRM",
    "config": {
      "resubmitMode": "Overwrite"
    },
    "sellerId": 1,
    "createdAt": "2025-03-10T12:00:00.000Z",
    "updatedAt": "2025-03-10T12:00:00.000Z"
  }
}

​
Требования к правам доступа

Для создания макета формы требуется право FormManage у сервисного пользователя.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.