Tags

Students and customers · 3 операції

GETList lead tags/api/tagPOSTCreate lead tag/api/tagPUTUpdate lead tag/api/tag/{id}

GET

List lead tags

/api/tag

Tags that can be put on leads.

list_tags

Параметри запиту · 5

pagenumberмін. 1 · за замовчуванням 1

pageSizenumber1–250 · за замовчуванням 20

tagIdsnumber[]—

nameOfTagstringобовʼязковий—

isArchivalobjectобовʼязковийза замовчуванням false

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject4 поля

totalnumberобовʼязковий—

totalPagesnumberобовʼязковий—

currentPagenumberобовʼязковий—

tagsobject[]обовʼязковий7 полів

tagIdnumberобовʼязковий—

nameOfTagstringобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl "https://your-school.rist.pro/api/tag?nameOfTag=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/tag?nameOfTag=string&isArchival=false", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/tag",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "nameOfTag": "string",
        "isArchival": False
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "tags": [
      {
        "tagId": 1,
        "nameOfTag": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

POST

Create lead tag

/api/tag

Add a tag for leads (name up to 30 characters, optional note).

create_tag

Тіло запиту

application/json · object

nameOfTagstringобовʼязковийдовжина 1–30

notestringобовʼязковийможе бути nullдовжина макс. 1500

Відповідь · 201

application/json

statusCodenumberобовʼязковийприклад 201

messagestringобовʼязковий—

dataobject7 полів

tagIdnumberобовʼязковий—

nameOfTagstringобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/tag" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfTag": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/tag", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfTag": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/tag",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfTag": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 201

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "tagId": 1,
    "nameOfTag": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update lead tag

/api/tag/{id}

Change name or note of a lead tag; name is always required.

update_tag

Параметри шляху · 1

idnumberобовʼязковий—

Тіло запиту

application/json · object

nameOfTagstringобовʼязковийдовжина 1–30

notestringобовʼязковийможе бути nullдовжина макс. 1500

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject7 полів

tagIdnumberобовʼязковий—

nameOfTagstringобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/tag/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfTag": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/tag/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfTag": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/tag/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfTag": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "tagId": 1,
    "nameOfTag": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}