KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
POST Отчёт
Источники
GET Список
POST Создать
GET Детали
PATCH Обновить
POST Деактивировать
POST Активировать
Клиенты
Аналитика
Склад (WM)
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Источники

Методы для управления источниками клиентов.

# Список источников

GET
/companies/{id}/modules/crm/sources

Возвращает список источников клиентов с пагинацией и фильтрацией.

Структура ответа

RESPONSE_DATA:
application/json
sourcesrequired
array
Источники
Список источников (Source[])
paginationrequired
array
pagination

Источник

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

GET_SOURCES_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
typeoptional
enum
organicsocialreferralpaidemailother
Тип
Фильтр по типу
statusoptional
enum
activeinactive
Статус
Фильтр по статусу
systemoptional
boolean
Системный
Фильтр по системным
searchoptional
string
Поиск
Поиск по названию

Примеры ответов

200
{
    "status": true,
    "message": "Sources retrieved successfully",
    "data": {
        "sources": [
            {
                "id": "c00e8400-e29b-41d4-a716-446655440080",
                "name": "Яндекс.Директ",
                "url": "https://yandex.ru/direct",
                "type": "paid",
                "comment": "Контекстная реклама",
                "system": false,
                "status": "active",
                "metadata": null,
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources",
        "method": "GET"
    }
}

# Создание источника

POST
/companies/{id}/modules/crm/sources

Создаёт новый источник клиентов.

Структура запроса

CREATE_REQUEST:
application/json
namerequired
string
Название
Название источника
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
urloptional
string
URL
Ссылка на источник
commentoptional
string
Комментарий
Комментарий
systemoptional
boolean
Системный
Системный источник
statusoptional
enum
activeinactive
Статус
Статус (по умолчанию active)
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Примеры ответов

201
{
    "status": true,
    "message": "Source created successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440081",
        "name": "Instagram",
        "url": "https://instagram.com",
        "type": "social",
        "comment": null,
        "system": false,
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:05:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources",
        "method": "POST"
    }
}

# Получение источника

GET
/companies/{id}/modules/crm/sources/{sourceId}

Возвращает информацию об источнике.

Структура ответа

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Source retrieved successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440080",
        "name": "Яндекс.Директ",
        "url": "https://yandex.ru/direct",
        "type": "paid",
        "comment": "Контекстная реклама",
        "system": false,
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:00:00Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources/...",
        "method": "GET"
    }
}

# Обновление источника

PATCH
/companies/{id}/modules/crm/sources/{sourceId}

Обновляет данные источника.

Структура запроса

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typeoptional
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
statusoptional
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Source updated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440081",
        "name": "Instagram (обновлено)",
        "url": "https://instagram.com",
        "type": "social",
        "comment": "Социальная сеть",
        "system": false,
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:10:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:10:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources/...",
        "method": "PATCH"
    }
}

# Деактивация источника

POST
/companies/{id}/modules/crm/sources/{sourceId}/deactivate

Деактивирует источник.

Структура ответа

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Source deactivated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440081",
        "name": "Instagram (обновлено)",
        "url": "https://instagram.com",
        "type": "social",
        "comment": "Социальная сеть",
        "system": false,
        "status": "inactive",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:15:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources/.../deactivate",
        "method": "POST"
    }
}

# Активация источника

POST
/companies/{id}/modules/crm/sources/{sourceId}/activate

Активирует деактивированный источник.

Структура ответа

SOURCE:
application/json
idrequired
string
ID
Уникальный идентификатор источника
namerequired
string
Название
Название источника
urloptional
string
URL
Ссылка на источник
typerequired
enum
organicsocialreferralpaidemailother
Тип
Тип источника
commentoptional
string
Комментарий
Комментарий
systemrequired
boolean
Системный
Системный источник
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Source activated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440081",
        "name": "Instagram (обновлено)",
        "url": "https://instagram.com",
        "type": "social",
        "comment": "Социальная сеть",
        "system": false,
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:20:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:20:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/sources/.../activate",
        "method": "POST"
    }
}