Состояния пользователя

curl --location 'https://api.exode.biz/saas/v2/user/123/state/get?key=PersonalInfoFilled' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function getState() {
  const { data } = await axios.get(
    'https://api.exode.biz/saas/v2/user/123/state/get',
    {
      params: { key: 'PersonalInfoFilled' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data);
}

getState();

<?php

$url = 'https://api.exode.biz/saas/v2/user/123/state/get?key=PersonalInfoFilled';
$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPGET, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;
?>

import requests

url = 'https://api.exode.biz/saas/v2/user/123/state/get'
headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, params={ 'key': 'PersonalInfoFilled' }, headers=headers)
print(response.json())

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/123/state/get?key=PersonalInfoFilled");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

Ответ = Соединение.ВызватьHTTPМетод("GET", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("Значение состояния получено");
Иначе
    Сообщить("Ошибка: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

curl --location --request PUT 'https://api.exode.biz/saas/v2/user/123/state/set?key=PersonalInfoFilled' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "value": true
  }'

const axios = require('axios');

async function setState() {
  const { data } = await axios.put(
    'https://api.exode.biz/saas/v2/user/123/state/set',
    { value: true },
    {
      params: { key: 'PersonalInfoFilled' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data);
}

setState();

<?php

$url = 'https://api.exode.biz/saas/v2/user/123/state/set?key=PersonalInfoFilled';
$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Content-Type: application/json',
  'Authorization: Bearer YOUR_TOKEN'
];

$payload = json_encode([ 'value' => true ]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;
?>

import requests

url = 'https://api.exode.biz/saas/v2/user/123/state/set'
headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.put(url, json={ 'value': { 'step': 3 } }, params={ 'key': 'PersonalInfoFilled' }, headers=headers)
print(response.json())

Данные = Новый Структура;
Данные.Вставить("value", Истина);

// Serialize body to JSON
ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Данные);
ТелоЗапроса = ЗаписьJSON.Закрыть();

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/123/state/set?key=PersonalInfoFilled");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Content-Type", "application/json");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

Ответ = Соединение.ВызватьHTTPМетод("PUT", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("Значение состояния сохранено");
Иначе
    Сообщить("Ошибка: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "success": true,
  "code": 200,
  "payload": {
    "value": true
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Unauthorized",
  "message": "Not allowed key KeyName",
  "error": "Not allowed key KeyName"
}

{
  "success": true,
  "code": 200,
  "payload": {
    "set": true
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Unauthorized",
  "message": "Not allowed key KeyName",
  "error": "Not allowed key KeyName"
}

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

string

required

API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.

string

required

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

string

required

Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

Состояния пользователя — это ключ-значение записи в базе, связанные с конкретным пользователем. Чтение и запись доступны только для ограниченного списка ключей (whitelist). Для некоторых ключей применяется маскирование при чтении.Эндпоинты ниже работают в контексте школы и требуют прав управления пользователями школы.Установка значения через PUT полностью замещает предыдущее значение ключа. Частичных обновлений (merge) нет.

Список поддерживаемых ключей

UtmSignupParams

Тип: object.
GET/SET: да/да.
Маскирование: нет.
Назначение: UTM/реферальные параметры первичного визита/регистрации.
UtmSignupParams хранится как объект произвольных строковых пар ключ-значение (например, utm_source, utm_medium, fbclid).

Success (GET UtmSignupParams)

{
  "success": true,
  "code": 200,
  "payload": {
    "value": {
      "fbclid": "EAA12xQ9YzGpKJ7tMoNybfBcGgGSsSixioGWZRcjvdAUCzvIjyGEXStvsIJC1wKj8ZpJ3kTn5Q2sL0mH7u9vW",
      "utm_term": "9876543210123456789",
      "utm_medium": "paid",
      "utm_source": "google",
      "utm_content": "creative_42_variant_b",
      "utm_campaign": "back_to_school_2025_ru"
    }
  }
}

Body (SET UtmSignupParams)

{
  "value": {
    "utm_source": "google",
    "utm_medium": "paid",
    "utm_campaign": "back_to_school_2025_ru",
    "utm_content": "creative_42_variant_b",
    "utm_term": "9876543210123456789",
    "fbclid": "EAA12xQ9YzGpKJ7tMoNybfBcGgGSsSixioGWZRcjvdAUCzvIjyGEXStvsIJC1wKj8ZpJ3kTn5Q2sL0mH7u9vW"
  }
}

PersonalInfoFilled

Тип: boolean.
GET/SET: да/да.
Маскирование: нет.
Назначение: Флаг заполнения персональных данных.
PersonalInfoFilled — булево значение true / false, отражающее факт заполнения персональных данных.

Success (GET PersonalInfoFilled)

{
  "success": true,
  "code": 200,
  "payload": {
    "value": true
  }
}

Body (SET PersonalInfoFilled)

{
  "value": true
}

OnBoardingProgress

Тип: object.
GET/SET: да/да.
Маскирование: нет.
Назначение: прогресс прохождения онбординга пользователем.

Body (SET OnBoardingProgress)

{
  "value": { "step": 3, "completed": false }
}

ContentCategoryIds

Тип: array.
GET/SET: да/да.
Маскирование: нет.
Назначение: выбранные пользователем категории контента (массив ID).

Body (SET ContentCategoryIds)

{
  "value": [12, 45, 78]
}

Запись (SET) разрешена только для ключей: UtmSignupParams, PersonalInfoFilled, OnBoardingProgress, ContentCategoryIds. Чтение (GET) дополнительно доступно для VkToken (возвращается замаскированным). Запрос к любому другому ключу вернёт ошибку Not allowed key.

Получить состояние по ключу

GET /saas/v2/user/:userId/state/get?key=PersonalInfoFilled

Параметры

integer

required

ID пользователя в рамках школы.

string

required

Ключ состояния.

Ответ

any

required

Значение состояния.

curl --location 'https://api.exode.biz/saas/v2/user/123/state/get?key=PersonalInfoFilled' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function getState() {
  const { data } = await axios.get(
    'https://api.exode.biz/saas/v2/user/123/state/get',
    {
      params: { key: 'PersonalInfoFilled' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data);
}

getState();

<?php

$url = 'https://api.exode.biz/saas/v2/user/123/state/get?key=PersonalInfoFilled';
$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPGET, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;
?>

import requests

url = 'https://api.exode.biz/saas/v2/user/123/state/get'
headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, params={ 'key': 'PersonalInfoFilled' }, headers=headers)
print(response.json())

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/123/state/get?key=PersonalInfoFilled");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

Ответ = Соединение.ВызватьHTTPМетод("GET", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("Значение состояния получено");
Иначе
    Сообщить("Ошибка: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

curl --location --request PUT 'https://api.exode.biz/saas/v2/user/123/state/set?key=PersonalInfoFilled' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "value": true
  }'

const axios = require('axios');

async function setState() {
  const { data } = await axios.put(
    'https://api.exode.biz/saas/v2/user/123/state/set',
    { value: true },
    {
      params: { key: 'PersonalInfoFilled' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data);
}

setState();

<?php

$url = 'https://api.exode.biz/saas/v2/user/123/state/set?key=PersonalInfoFilled';
$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Content-Type: application/json',
  'Authorization: Bearer YOUR_TOKEN'
];

$payload = json_encode([ 'value' => true ]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;
?>

import requests

url = 'https://api.exode.biz/saas/v2/user/123/state/set'
headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.put(url, json={ 'value': { 'step': 3 } }, params={ 'key': 'PersonalInfoFilled' }, headers=headers)
print(response.json())

Данные = Новый Структура;
Данные.Вставить("value", Истина);

// Serialize body to JSON
ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Данные);
ТелоЗапроса = ЗаписьJSON.Закрыть();

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/123/state/set?key=PersonalInfoFilled");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Content-Type", "application/json");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

Ответ = Соединение.ВызватьHTTPМетод("PUT", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("Значение состояния сохранено");
Иначе
    Сообщить("Ошибка: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "success": true,
  "code": 200,
  "payload": {
    "value": true
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Unauthorized",
  "message": "Not allowed key KeyName",
  "error": "Not allowed key KeyName"
}

{
  "success": true,
  "code": 200,
  "payload": {
    "set": true
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Unauthorized",
  "message": "Not allowed key KeyName",
  "error": "Not allowed key KeyName"
}

Установить состояние по ключу

PUT /saas/v2/user/:userId/state/set?key=PersonalInfoFilled

Параметры

integer

required

ID пользователя в рамках школы.

string

required

Ключ состояния.

any

required

Значение, записываемое в состояние. Тип зависит от ключа.

Ответ

boolean

required

Флаг успешной записи состояния.

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

Требуется аутентификация по токену и право управления пользователями школы (SchoolManageUsers).

Обновлено: 2026-07-02 23:44 UTC

Работа с API

Пользователи

Сотрудники (HR)

Группы

Курсы

Доступы и продажи

Отчеты и выгрузки

Кастомные поля

Формы

Нет нужного метода?

Все объекты

Состояния пользователя

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

Список поддерживаемых ключей

Получить состояние по ключу

Параметры

Ответ

Установить состояние по ключу

Параметры

Ответ

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

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

​Список поддерживаемых ключей

​Получить состояние по ключу

​Параметры

​Ответ

​Установить состояние по ключу

​Параметры

​Ответ

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

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

Список поддерживаемых ключей

Получить состояние по ключу

Параметры

Ответ

Установить состояние по ключу

Параметры

Ответ

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