User states

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);
    Сообщить("State value received");
Иначе
    Сообщить("Error: 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);
    Сообщить("State value saved");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

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

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

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

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

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);
    Сообщить("State value received");
Иначе
    Сообщить("Error: 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);
    Сообщить("State value saved");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

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

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

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

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

Request headers

string

required

The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.

integer

required

The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.

integer

required

The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.

User states are key-value records in the database linked to a specific user. Reading and writing are available only for a limited list of keys (whitelist). Some keys are masked on read.The endpoints below work in the school context and require the school user management permission.Setting a value via PUT fully replaces the key’s previous value. There are no partial updates (merge).

Supported keys

UtmSignupParams

Type: object.
GET/SET: yes/yes.
Masking: no.
Purpose: UTM/referral parameters of the first visit/sign-up.
UtmSignupParams is stored as an object of arbitrary string key-value pairs (for example, 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

Type: boolean.
GET/SET: yes/yes.
Masking: no.
Purpose: flag indicating that personal information has been filled in.
PersonalInfoFilled is a boolean true / false value indicating whether personal information has been filled in.

Success (GET PersonalInfoFilled)

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

Body (SET PersonalInfoFilled)

{
  "value": true
}

OnBoardingProgress

Type: object.
GET/SET: yes/yes.
Masking: no.
Purpose: the user’s onboarding progress.

Body (SET OnBoardingProgress)

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

ContentCategoryIds

Type: array.
GET/SET: yes/yes.
Masking: no.
Purpose: content categories selected by the user (an array of IDs).

Body (SET ContentCategoryIds)

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

Writing (SET) is allowed only for the keys UtmSignupParams, PersonalInfoFilled, OnBoardingProgress, ContentCategoryIds. Reading (GET) is additionally available for VkToken (returned masked). A request for a key outside this list returns a 400 error with cause: "Unauthorized" and the message Not allowed key <key> — this is a key restriction, not a token problem. A non-existent key name is rejected by validation (400).

Get a state by key

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

Parameters

integer

required

The user’s numeric ID in Exode (the id field from user/find or user/list). The user must belong to the school from the School-Id header.

string

required

State key — one of the values from the list above, case-sensitive.

Response

any

required

The state value. If no value has been written for the key yet, null.

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);
    Сообщить("State value received");
Иначе
    Сообщить("Error: 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);
    Сообщить("State value saved");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

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

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

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

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

Set a state by key

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

Parameters

integer

required

The user’s numeric ID in Exode (the id field from user/find or user/list). The user must belong to the school from the School-Id header.

string

required

State key — one of the values from the list above, case-sensitive.

any

required

The value to write to the state. Its type depends on the key.

Response

boolean

required

Flag indicating that the state was written successfully.

Permission requirements

Requires token authentication and the “School User Management” permission (SchoolManageUsers).

Updated: 2026-09-25 14:33 UTC

Working with the API

Users

Staff (HR)

Groups

Courses

Access and sales

Reports and exports

Custom fields

Forms

Missing a method?

All objects

Request headers

Supported keys

Get a state by key

Parameters

Response

Set a state by key

Parameters

Response

Permission requirements

​Request headers

​Supported keys

​Get a state by key

​Parameters

​Response

​Set a state by key

​Parameters

​Response

​Permission requirements

Request headers

Supported keys

Get a state by key

Parameters

Response

Set a state by key

Parameters

Response

Permission requirements