Перейти к содержимому
AISARAISAR
REST API

Метки

Метки — простые именованные ярлыки компании (с опциональным цветом), которыми размечаются контакты и диалоги для последующей фильтрации, сегментации аудитории и запуска автоматизаций. Этот раздел — CRUD самого справочника меток.

Уникальность имени

Имя метки уникально в рамках компании.

Привязка к контактам и диалогам

Привязка/отвязка метки к конкретному контакту или диалогу выполняется через соответствующие эндпоинты (POST /contacts/{contact}/tags, POST /conversations/{conversation}/tags), а этот раздел — CRUD самого справочника меток.

Поля запросов создания и обновления

В запросах создания и обновления:

  • name — обязательная строка до 255 символов.
  • color — необязательный 6-значный HEX-код вида #RRGGBB (либо null).

Эндпоинты

МетодПуть
GET/v1/tags

Список меток компании (с поиском по имени).

POST/v1/tags

Создать метку.

PATCH/v1/tags/{tag}

Обновить имя или цвет метки.

DELETE/v1/tags/{tag}

Удалить метку.

Примеры

Создание метки

Запрос

bash
curl -X POST "https://api.aisar.app/v1/tags" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "vip",
    "color": "#22c55e"
  }'

Ответ

json
{
  "data": {
    "message": "Tag created.",
    "tag": {
      "id": 7,
      "company_id": 1,
      "name": "vip",
      "color": "#22c55e",
      "created_at": "2026-02-09T18:00:00Z",
      "updated_at": "2026-02-09T18:00:00Z"
    }
  }
}

Список меток

Запрос

bash
curl -X GET "https://api.aisar.app/v1/tags?search=vip" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Ответ

json
{
  "data": [
    {
      "id": 7,
      "company_id": 1,
      "name": "vip",
      "color": "#22c55e",
      "created_at": "2026-02-09T18:00:00Z",
      "updated_at": "2026-02-09T18:00:00Z"
    }
  ]
}

Обновление метки

Запрос

bash
curl -X PATCH "https://api.aisar.app/v1/tags/7" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "priority",
    "color": "#e11d48"
  }'

Ответ

json
{
  "data": {
    "message": "Tag updated.",
    "tag": {
      "id": 7,
      "company_id": 1,
      "name": "priority",
      "color": "#e11d48",
      "created_at": "2026-02-09T18:00:00Z",
      "updated_at": "2026-02-10T09:30:00Z"
    }
  }
}