Версия API 1.0.0; документ собран из docs/registry/api/openapi.json (OpenAPI 3, отпечаток 5935cd792dff4ac6) генератором apps/api/scripts/openapi-to-markdown.mjs. Всего операций: 476, из них по токену: 391.
1. Общие правила
https://<адрес установки>/v1. Все пути ниже — относительно /v1.
refresh — в httpOnly cookie); запросы — с заголовком Authorization: Bearer <access>. Для внешних систем — ключи организации (раздел «API ключи» кабинета), тот же заголовок. Права — по роли участника (владелец, администратор, маркетолог, продажи, наблюдатель); экраны администратора платформы — только для него.
данные других организаций недоступны на уровне базы (RLS).
Списки — постранично (page, pageSize или cursor, как указано в параметрах).
Idempotency-Key; повтор с тем же ключом возвращает первый результат.
— список замечаний валидации (Zod), code — машинный код (например outbound_blocked в установке без интернета). requestId — для поддержки.
владельца, сброс, первый владелец установки в контуре), любая операция по токену, кроме GET /auth/me и PATCH /auth/me/password, отвечает 403 с code: password_change_required; признак — mustChangePassword в ответе входа и /auth/me.
завершают выданные до этого токены сразу (401); смена возвращает текущей сессии новую пару (access — в теле и cookie, refresh — только в cookie).
превышении — 429 с Retry-After.
изменение событий невозможно.
- Адрес. Облако:
https://api.abmpersona.ru/v1; установка в контуре: - Доступ. Вход
POST /auth/loginвыдаёт пару токенов (access — короткий, - Организация. Каждый запрос выполняется в контексте организации токена;
- Формат. JSON, поля camelCase, пути kebab-case, даты ISO 8601 (UTC).
- Идемпотентность. Изменяющие запросы принимают заголовок
- Ошибки.
{ statusCode, message, requestId, code?, issues? };issues - Временный пароль. Пока пароль учётной записи выдан сервером (участник от
- Токены после смены пароля. Смена своего пароля и сброс владельцем
- Ограничение частоты. Счётчики в Redis, общие для всех реплик; при
- Идентификаторы. UUID; события — только добавление (ClickHouse),
2. Операции по разделам
Вход, сессии и организации
Теги OpenAPI: auth, auth-sessions, auth-workspaces, me, tenants, onboarding, api-keys.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /api-keys | список | по токену |
POST | /api-keys | создать | по токену |
DELETE | /api-keys/{id} | отозвать | по токену |
POST | /auth/login | вход | открытый |
POST | /auth/logout | выход | открытый |
GET | /auth/me | текущий пользователь | по токену |
PATCH | /auth/me/password | change password | по токену |
POST | /auth/refresh | обновить токен | открытый |
POST | /auth/register | регистрация | открытый |
GET | /auth/sessions | список | по токену |
DELETE | /auth/sessions/{id} | отозвать | по токену |
POST | /auth/sessions/revoke-all | отозвать: all | по токену |
GET | /auth/workspaces | список | по токену |
POST | /auth/workspaces | создать | по токену |
POST | /auth/workspaces/current/invitations | создать: invitation | по токену |
GET | /auth/workspaces/current/members | members | по токену |
POST | /auth/workspaces/current/members | создать: member | по токену |
PATCH | /auth/workspaces/current/members/{id} | изменить: member | по токену |
POST | /auth/workspaces/current/members/{id}/password-reset | reset member password | по токену |
POST | /auth/workspaces/invitations/preview | предпросмотр: invitation | по токену |
POST | /auth/workspaces/invitations/redeem | redeem invitation | по токену |
POST | /auth/workspaces/switch/{id} | switch workspace | по токену |
GET | /me | текущий пользователь | по токену |
GET | /me/business-profile | получить | по токену |
PUT | /me/business-profile | изменить | по токену |
GET | /me/onboarding | получить | по токену |
PUT | /me/onboarding | изменить | по токену |
GET | /me/ui-prefs | read | по токену |
PATCH | /me/ui-prefs | изменить | по токену |
База компаний и контакты
Теги OpenAPI: accounts, contacts, account-notes, account-brief, account-plan, account-goals, call-brief, dossier, buying-committee, imports, discovery, fns, company-data, touchpoints, analytics-timeline, analytics-activity, events.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /accounts | список (параметры: industry, lifecycle, region, q, rfm, stage, limit, offset, sort, dir) | по токену |
POST | /accounts | создать | по токену |
GET | /accounts/{accountId}/brief | latest | по токену |
POST | /accounts/{accountId}/brief/{briefId}/execute | execute | по токену |
POST | /accounts/{accountId}/brief/{briefId}/feedback | feedback | по токену |
POST | /accounts/{accountId}/brief/{briefId}/review | review | по токену |
GET | /accounts/{accountId}/brief/feedback | feedback history | по токену |
POST | /accounts/{accountId}/brief/generate | generate | по токену |
GET | /accounts/{accountId}/contacts/{contactId}/email-drafts | список | открытый |
POST | /accounts/{accountId}/contacts/{contactId}/email-drafts | save | открытый |
GET | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id} | получить | открытый |
PATCH | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id} | edit | открытый |
GET | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/history | история (параметры: before) | открытый |
GET | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/history/{version} | revision | открытый |
GET | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/history/{version}/feedback | feedback | открытый |
POST | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/history/{version}/feedback | save feedback | открытый |
POST | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/refresh | обновить токен | открытый |
POST | /accounts/{accountId}/contacts/{contactId}/email-drafts/{id}/review | review | открытый |
GET | /accounts/{id} | получить | по токену |
PATCH | /accounts/{id} | изменить | по токену |
DELETE | /accounts/{id} | удалить | по токену |
GET | /accounts/{id}/activity | список | по токену |
GET | /accounts/{id}/call-brief | brief | по токену |
GET | /accounts/{id}/call-brief.docx | docx | по токену |
GET | /accounts/{id}/company-card | card | по токену |
POST | /accounts/{id}/company-data/refresh | обновить токен | по токену |
GET | /accounts/{id}/contacts | список: contacts | по токену |
POST | /accounts/{id}/contacts | создать: contact | по токену |
POST | /accounts/{id}/fields/{field}/choose | choose | по токену |
GET | /accounts/{id}/fields/{field}/history | история | по токену |
GET | /accounts/{id}/goals | for account | по токену |
POST | /accounts/{id}/goals | создать | по токену |
GET | /accounts/{id}/interactions | interactions | по токену |
GET | /accounts/{id}/notes | список | по токену |
POST | /accounts/{id}/notes | создать | по токену |
DELETE | /accounts/{id}/notes/{noteId} | удалить | по токену |
GET | /accounts/{id}/plan-items | список | по токену |
POST | /accounts/{id}/plan-items | создать | по токену |
PATCH | /accounts/{id}/plan-items/{itemId} | изменить | по токену |
DELETE | /accounts/{id}/plan-items/{itemId} | удалить | по токену |
GET | /accounts/{id}/timeline | build | по токену |
GET | /accounts/{id}/timeline/spans | spans | по токену |
POST | /accounts/{id}/touchpoints | создать | по токену |
POST | /accounts/bulk-delete | bulk delete | по токену |
POST | /accounts/dedupe-preview | dedupe preview | по токену |
GET | /buying-committee/{accountId} | for account | по токену |
PUT | /buying-committee/dictionary | save | по токену |
GET | /buying-committee/dictionary/current | dictionary | по токену |
POST | /buying-committee/dictionary/preview | предпросмотр | по токену |
GET | /buying-committee/dictionary/unmapped | unmapped (параметры: limit) | по токену |
GET | /buying-committee/gaps | gaps (параметры: function, limit) | по токену |
GET | /call-briefs/batch | список | по токену |
POST | /call-briefs/batch | создать | по токену |
GET | /call-briefs/batch/{id}/file | file | по токену |
GET | /company-data/sources | sources | по токену |
POST | /company-data/sources/{source}/refresh | обновить токен: source | по токену |
GET | /company-data/vendors | список | по токену |
POST | /company-data/vendors/{kind} | подключить | по токену |
PATCH | /contacts/{id} | изменить: contact | по токену |
POST | /contacts/{id}/merge | merge | по токену |
GET | /contacts/{id}/reveal | reveal | по токену |
POST | /contacts/{id}/tg-link/generate-code | generate code | по токену |
GET | /contacts/duplicates | список | по токену |
GET | /contacts/reveal-availability | availability | по токену |
GET | /discovery/{id}/name | reveal name | по токену |
POST | /discovery/{id}/promote | promote | по токену |
POST | /discovery/{id}/reject | отклонить | по токену |
GET | /discovery/capabilities | capabilities | по токену |
GET | /discovery/queue | queue | по токену |
POST | /discovery/run | запустить | по токену |
POST | /discovery/scan-sites | scan sites | по токену |
GET | /dossier/{accountId} | build | по токену |
POST | /dossier/{accountId}/summary | сводка | по токену |
GET | /events | список | по токену |
POST | /events/ingest | ingest | по токену |
GET | /fns/inn-check | state | по токену |
POST | /fns/inn-check | запустить | по токену |
GET | /fns/inn-check/{accountId} | inn for account | по токену |
GET | /fns/msp-import | msp status | по токену |
POST | /fns/msp-import | импортировать: msp | по токену |
GET | /fns/msp/{accountId} | msp for account | по токену |
GET | /goals | список | по токену |
PATCH | /goals/{id} | изменить | по токену |
DELETE | /goals/{id} | cancel | по токену |
POST | /goals/{id}/status | состояние | по токену |
GET | /goals/owners | owners | по токену |
GET | /imports/{id} | состояние | по токену |
POST | /imports/{id}/mapping | mapping | по токену |
POST | /imports/{id}/start | запустить | по токену |
GET | /imports/template | template | по токену |
POST | /imports/upload | загрузить | по токену |
Сегменты и скоринг
Теги OpenAPI: segments, segments-ai, filter-sets, scoring, predictive, surges, insights, external-signals.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /accounts/{id}/signals | for account | по токену |
GET | /accounts/{id}/surge-history | surge history | по токену |
GET | /accounts/{id}/surge-history/{topicId}/timeline | surge timeline (параметры: days) | по токену |
GET | /content-topics | список: topics | по токену |
POST | /content-topics | создать: topic | по токену |
PATCH | /content-topics/{id} | изменить: topic | по токену |
DELETE | /content-topics/{id} | удалить: topic | по токену |
GET | /filter-sets | список | по токену |
POST | /filter-sets | создать | по токену |
GET | /filter-sets/{key} | получить | по токену |
PATCH | /filter-sets/{key} | изменить | по токену |
DELETE | /filter-sets/{key} | удалить | по токену |
GET | /filter-sets/{key}/usage | usage | по токену |
POST | /insights/explain | explain | по токену |
GET | /predictive/accounts/{accountId} | получить: account | по токену |
POST | /predictive/accounts/{accountId}/recompute | пересчитать: account | по токену |
GET | /predictive/jobs/{jobId} | job status | по токену |
GET | /predictive/model-card/{target} | model card | по токену |
POST | /predictive/model/{target}/resume | возобновить | по токену |
GET | /predictive/monitoring | monitoring | по токену |
POST | /predictive/monitoring/evaluate | evaluate | по токену |
POST | /predictive/train | train | по токену |
GET | /scoring/{accountId} | by account | по токену |
GET | /scoring/{accountId}/explain | explain (параметры: axes) | по токену |
GET | /scoring/{accountId}/history | история (параметры: days) | по токену |
GET | /scoring/3axis-distribution | three axis (параметры: color) | по токену |
POST | /scoring/engagement/run | engagement | по токену |
GET | /scoring/icp-fit/{accountId} | icp fit for | по токену |
GET | /scoring/icp-profile | icp profile | по токену |
GET | /scoring/insights/anomalies | anomalies | по токену |
GET | /scoring/jobs/{id} | job | по токену |
POST | /scoring/lifecycle/run | lifecycle | по токену |
GET | /scoring/lifecycle/transition-matrix | transition matrix | по токену |
GET | /scoring/qualifications | qualifications (параметры: limit) | по токену |
POST | /scoring/recompute | пересчитать | по токену |
POST | /scoring/rfm/run | rfm | по токену |
GET | /scoring/summary | сводка | по токену |
GET | /segments | список | по токену |
POST | /segments | создать | по токену |
GET | /segments/{id} | получить | по токену |
PATCH | /segments/{id} | изменить | по токену |
DELETE | /segments/{id} | удалить | по токену |
GET | /segments/{id}/accounts | accounts (параметры: cursor, limit) | по токену |
POST | /segments/{id}/calculate | calculate | по токену |
POST | /segments/{id}/members | add members | по токену |
DELETE | /segments/{id}/members | удалить: members | по токену |
GET | /segments/{id}/playbook-performance | playbook performance (параметры: playbookId) | по токену |
GET | /segments/{id}/timeline | timeline (параметры: bucket) | по токену |
GET | /segments/coverage | coverage | по токену |
POST | /segments/from-template/{templateId} | from template | по токену |
POST | /segments/preview | предпросмотр (параметры: limit) | по токену |
POST | /segments/preview/steps | предпросмотр: steps | по токену |
GET | /segments/profiles | profiles | по токену |
GET | /segments/templates | templates | по токену |
POST | /segments/translate-from-text | translate | по токену |
GET | /surges | список: surges | по токену |
POST | /surges/dispatch-alerts | dispatch alerts | по токену |
POST | /surges/run-detection | запустить: detection | по токену |
Кампании, шаблоны, мероприятия
Теги OpenAPI: playbooks, playbooks-graph, playbook-templates, email-copy, ab-testing, marketing-events, event-effectiveness, hypotheses, video, telegram, inbound.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
POST | /ab/promote/{templateId} | promote | по токену |
DELETE | /ab/promote/{templateId} | clear winner | по токену |
GET | /ab/stats/{templateId} | статистика | по токену |
POST | /ai/email-copy/generate | generate | по токену |
POST | /ai/email-copy/save-variants | save variants | по токену |
GET | /email-templates | список | по токену |
POST | /email-templates | создать | по токену |
GET | /email-templates/{id} | получить | по токену |
POST | /email-templates/{id}/decide | решение (одобрить/отклонить) | по токену |
GET | /email-templates/{id}/feedback | список | по токену |
POST | /email-templates/{id}/feedback | save | по токену |
GET | /event-effectiveness/library | library | по токену |
POST | /event-effectiveness/metrics | создать: metric | по токену |
PATCH | /event-effectiveness/metrics/{key} | изменить: metric | по токену |
GET | /event-effectiveness/portfolio | portfolio | по токену |
GET | /event-effectiveness/settings | settings | по токену |
PATCH | /event-effectiveness/settings | изменить: settings | по токену |
GET | /hypotheses | список: all | по токену |
POST | /hypotheses/{id}/accept | accept | по токену |
POST | /hypotheses/{id}/activate-playbook | activate playbook | по токену |
GET | /hypotheses/{id}/activation | activation status | по токену |
GET | /hypotheses/{id}/feedback | получить: feedback | по токену |
POST | /hypotheses/{id}/feedback | save feedback | по токену |
POST | /hypotheses/{id}/reject | отклонить | по токену |
GET | /hypotheses/activation-queue | activation queue | по токену |
POST | /hypotheses/batch-accept | batch accept | по токену |
GET | /hypotheses/stats | статистика | по токену |
POST | /inbound/mailbox | подключить | по токену |
GET | /inbound/replies | список | по токену |
GET | /inbound/replies/{id}/decision | inspect | открытый |
POST | /inbound/replies/{id}/decision | решение (одобрить/отклонить) | открытый |
GET | /inbound/replies/{id}/text | text | по токену |
GET | /marketing-events | список | по токену |
POST | /marketing-events | создать | по токену |
GET | /marketing-events/{id} | by id | по токену |
PATCH | /marketing-events/{id} | изменить | по токену |
GET | /marketing-events/{id}/evaluation | получить | по токену |
POST | /marketing-events/{id}/evaluation | создать | по токену |
PATCH | /marketing-events/{id}/evaluation | passport | по токену |
POST | /marketing-events/{id}/evaluation/approval-link | approval link | по токену |
POST | /marketing-events/{id}/evaluation/archive | archive | по токену |
POST | /marketing-events/{id}/evaluation/decision | decision | по токену |
PUT | /marketing-events/{id}/evaluation/metrics | plan | по токену |
POST | /marketing-events/{id}/evaluation/observations | add observation | по токену |
DELETE | /marketing-events/{id}/evaluation/observations/{oid} | удалить: observation | по токену |
POST | /marketing-events/{id}/evaluation/reopen | reopen | по токену |
GET | /marketing-events/{id}/evaluation/results | results | по токену |
POST | /marketing-events/{id}/evaluation/revise | revise | по токену |
POST | /marketing-events/{id}/evaluation/sign | sign | по токену |
POST | /marketing-events/{id}/evaluation/start | запустить | по токену |
POST | /marketing-events/{id}/evaluation/submit | submit | по токену |
GET | /marketing-events/{id}/participants | participants | по токену |
POST | /marketing-events/{id}/participants | add participants | по токену |
POST | /marketing-events/{id}/participants/from-accounts | add from accounts | по токену |
POST | /marketing-events/{id}/participants/from-segment | add from segment | по токену |
POST | /marketing-events/{id}/participants/state | set state | по токену |
POST | /me/telegram/connect-code | создать: code | по токену |
GET | /me/telegram/status | состояние | по токену |
GET | /playbook-templates | список (параметры: vertical) | по токену |
GET | /playbook-templates/{id} | получить | по токену |
POST | /playbook-templates/{id}/clone | clone | по токену |
GET | /playbooks | список | по токену |
POST | /playbooks | создать | по токену |
GET | /playbooks/{id} | получить | по токену |
POST | /playbooks/{id}/activate | activate | по токену |
GET | /playbooks/{id}/approval | предпросмотр | открытый |
POST | /playbooks/{id}/approval/decision | решение (одобрить/отклонить) | открытый |
GET | /playbooks/{id}/approval/decisions/{decisionId}/materials | materials | открытый |
PUT | /playbooks/{id}/approval/settings | settings | открытый |
POST | /playbooks/{id}/approval/spend-baseline | record baseline | открытый |
GET | /playbooks/{id}/audience | current | открытый |
POST | /playbooks/{id}/audience/freeze | freeze | открытый |
GET | /playbooks/{id}/audience/preview | предпросмотр | открытый |
GET | /playbooks/{id}/costs | список (параметры: before) | открытый |
POST | /playbooks/{id}/costs | создать | открытый |
GET | /playbooks/{id}/costs/{operationId}/history | история (параметры: before) | открытый |
POST | /playbooks/{id}/costs/{operationId}/revisions | revise | открытый |
GET | /playbooks/{id}/deliveries | список (параметры: before, pausedBefore, from, until) | открытый |
POST | /playbooks/{id}/deliveries/{attemptId}/continuation | continue delivery | открытый |
POST | /playbooks/{id}/deliveries/{attemptId}/reconcile | решение (одобрить/отклонить) | открытый |
POST | /playbooks/{id}/enroll | enroll | по токену |
GET | /playbooks/{id}/graph | load graph | по токену |
PUT | /playbooks/{id}/graph | save graph | по токену |
GET | /playbooks/{id}/messages | получить | открытый |
POST | /playbooks/{id}/messages/{stepId}/create-variant | variant | открытый |
POST | /playbooks/{id}/messages/{stepId}/save-text | save | открытый |
POST | /playbooks/{id}/messages/{stepId}/select-template | select | открытый |
POST | /playbooks/{id}/pause | приостановить | по токену |
GET | /playbooks/{id}/preparation | получить | открытый |
PUT | /playbooks/{id}/preparation | save | открытый |
POST | /playbooks/{id}/preparation/use-business-profile | copy | открытый |
POST | /playbooks/{id}/scenario | apply | открытый |
GET | /playbooks/{id}/scenario/{templateId} | предпросмотр | открытый |
GET | /playbooks/{id}/stats | статистика | по токену |
GET | /playbooks/{id}/targets | список (параметры: before) | открытый |
POST | /playbooks/{id}/targets | создать | открытый |
GET | /playbooks/{id}/targets/{eventId}/history | история (параметры: before) | открытый |
POST | /playbooks/{id}/targets/{eventId}/revisions | revise | открытый |
GET | /playbooks/{id}/targets/candidates | candidates | открытый |
POST | /playbooks/{id}/test-run | проверить подключение: run | по токену |
GET | /playbooks/{id}/validate | validate | по токену |
GET | /playbooks/branch-vars | branch vars | по токену |
POST | /playbooks/comparison | compare | открытый |
GET | /playbooks/step-capabilities | step capabilities | по токену |
GET | /public/event-approval/{token} | view | открытый |
POST | /public/event-approval/{token} | решение (одобрить/отклонить) | открытый |
GET | /segments/{id}/hypotheses | список | по токену |
POST | /segments/{id}/hypotheses/generate | generate | по токену |
GET | /v/{videoId}/{token} | open | открытый |
GET | /videos | список | по токену |
POST | /videos | создать | по токену |
DELETE | /videos/{id} | archive | по токену |
POST | /webhooks/telegram | receive | открытый |
Результаты и аналитика
Теги OpenAPI: analytics-attribution, abm-metrics, review, pipeline, crm, program, recommendations.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /abm-metrics | panel | по токену |
GET | /abm-metrics/survey/index | index | по токену |
GET | /abm-metrics/survey/questions | questions | по токену |
GET | /abm-metrics/survey/waves | waves | по токену |
POST | /abm-metrics/survey/waves | создать: wave | по токену |
POST | /abm-metrics/survey/waves/{id}/close | close wave | по токену |
POST | /abm-metrics/survey/waves/{id}/responses | add response | по токену |
GET | /accounts/{id}/pipeline | for account | по токену |
PUT | /accounts/{id}/pipeline/stage | set stage | по токену |
DELETE | /accounts/{id}/pipeline/stage | clear stage | по токену |
POST | /accounts/{id}/tasks | создать: task | по токену |
GET | /analytics/attribution | compute | по токену |
GET | /analytics/attribution/config | получить: config | по токену |
PUT | /analytics/attribution/config | изменить: config | по токену |
GET | /analytics/attribution/engagement | engagement | по токену |
GET | /analytics/attribution/shapley | shapley | по токену |
GET | /analytics/attribution/shapley/by-segment | by segment | по токену |
GET | /analytics/attribution/shapley/timeline | timeline | по токену |
GET | /analytics/attribution/shapley/transition | stage shapley | по токену |
GET | /analytics/attribution/shapley/transitions | stage transitions | по токену |
GET | /dashboard | dashboard | по токену |
POST | /integrations/{id}/sync | синхронизировать | по токену |
POST | /integrations/{id}/writeback | writeback | по токену |
POST | /integrations/{id}/writeback/enabled | toggle writeback | по токену |
GET | /integrations/amocrm/authorize | amo authorize (параметры: subdomain) | по токену |
GET | /integrations/amocrm/callback | amo callback | открытый |
POST | /integrations/bitrix24/connect | b24connect | по токену |
GET | /integrations/capabilities | capabilities | по токену |
GET | /pipeline/conversion | conversion | по токену |
GET | /pipeline/funnel | funnel (параметры: industry, lifecycle, region, q, rfm) | по токену |
GET | /program | plan | по токену |
POST | /program/notes | add note | по токену |
POST | /program/stages | создать: stage | по токену |
POST | /program/stages/{id}/status | set status | по токену |
POST | /recommendations/{recommendationId}/decide | решение (одобрить/отклонить) | по токену |
GET | /recommendations/accounts/{accountId} | список: for account | по токену |
GET | /recommendations/metrics | metrics | по токену |
GET | /recommendations/pending | список: pending | по токену |
POST | /recommendations/rules/run | запустить: rules | по токену |
GET | /review | получить | по токену |
PUT | /review/plan | set plan | по токену |
GET | /tasks | tasks (параметры: limit) | по токену |
POST | /tasks/{id}/complete | complete task | по токену |
POST | /webhooks/amocrm/{tenantId} | amo webhook | открытый |
POST | /webhooks/bitrix24/{tenantId} | b24webhook | открытый |
Интеграции, вебхуки, пиксель
Теги OpenAPI: integrations, webhooks, webhooks-outgoing, tracking, ad-cabinets, ad-audiences, notifications.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /ad-cabinets | список | по токену |
POST | /ad-cabinets/{platform} | подключить | по токену |
DELETE | /ad-cabinets/{platform} | отключить | по токену |
GET | /integrations | список | по токену |
POST | /integrations/{kind}/{label}/sync | синхронизировать | по токену |
DELETE | /integrations/by-id/{id} | отключить (параметры: confirm) | по токену |
GET | /integrations/by-id/{id}/disconnect-impact | impact | по токену |
POST | /integrations/connect | подключить | по токену |
DELETE | /integrations/glabix | отключить: glabix | по токену |
DELETE | /integrations/metrika | отключить | по токену |
POST | /integrations/metrika/connect | подключить | по токену |
GET | /integrations/metrika/goals | goals | по токену |
PUT | /integrations/metrika/goals | set goals | по токену |
POST | /integrations/metrika/import | запустить: import | по токену |
GET | /integrations/metrika/status | состояние | по токену |
POST | /integrations/unisender-go/connect | подключить | по токену |
GET | /integrations/unisender-go/status | состояние | по токену |
POST | /integrations/unisender-go/test | проверить подключение | по токену |
GET | /notifications | список | по токену |
PATCH | /notifications/read-all | mark read | по токену |
GET | /segments/{id}/audience-syncs | список | по токену |
POST | /segments/{id}/sync-to-vk | синхронизировать: to vk | по токену |
POST | /segments/{id}/sync-to-yandex | синхронизировать: to yandex | по токену |
POST | /track | track | открытый |
POST | /webhooks/csp-report | receive | открытый |
POST | /webhooks/mts-exolve | receive | открытый |
GET | /webhooks/outgoing | список | по токену |
POST | /webhooks/outgoing | создать | по токену |
PATCH | /webhooks/outgoing/{id} | изменить | по токену |
DELETE | /webhooks/outgoing/{id} | удалить | по токену |
GET | /webhooks/outgoing/{id}/deliveries | deliveries (параметры: limit) | по токену |
GET | /webhooks/outgoing/events | events | по токену |
POST | /webhooks/unisender-go | receive | открытый |
Функции ИИ: тексты, качество, улучшения, стирание
Теги OpenAPI: ai.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
POST | /ai/contact-copy | generate | по токену |
POST | /ai/contact-copy/generate | generate async | по токену |
GET | /ai/improvements | список | по токену |
POST | /ai/improvements | создать | по токену |
GET | /ai/improvements/{id} | получить | по токену |
PATCH | /ai/improvements/{id} | change | по токену |
POST | /ai/improvements/{id}/cases | add case | по токену |
GET | /ai/improvements/{id}/cases/{caseId} | получить: case | по токену |
POST | /ai/improvements/{id}/cases/{caseId}/comparison-preview | предпросмотр: comparison | по токену |
POST | /ai/improvements/{id}/cases/{caseId}/erase | erase case | по токену |
GET | /ai/improvements/{id}/cases/{caseId}/export | выгрузить: case | по токену |
GET | /ai/improvements/{id}/changes | changes | по токену |
POST | /ai/improvements/{id}/text/erase | erase task text | по токену |
GET | /ai/improvements/sources | sources | по токену |
GET | /ai/jobs/{id} | состояние | по токену |
GET | /ai/prompt-releases/{promptName} | история | по токену |
POST | /ai/prompt-releases/{promptName}/rollback | rollback | по токену |
POST | /ai/prompt-releases/{promptName}/versions/{version}/events/{id}/erase | erase version reason | по токену |
GET | /ai/prompt-releases/{promptName}/versions/{version}/state | version state (параметры: hash, offset) | по токену |
POST | /ai/prompt-releases/{promptName}/versions/{version}/state | change version | по токену |
POST | /ai/prompt-releases/tasks/{id}/cases/{caseId}/activate | activate | по токену |
GET | /ai/quality | overview | по токену |
POST | /ai/quality/accounts/{id}/contexts/erase | erase account contexts | по токену |
GET | /ai/quality/accounts/erase-lookup | find accounts for erasure | по токену |
GET | /ai/quality/calls/{id}/context | call context | по токену |
POST | /ai/quality/calls/{id}/context/erase | erase call context | по токену |
POST | /ai/quality/evaluations | импортировать: summary | по токену |
GET | /ai/quality/evaluations/{id} | evaluation | по токену |
Персональные данные и аудит
Теги OpenAPI: compliance, audit.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /audit | список | по токену |
GET | /audit/actions | actions | по токену |
GET | /audit/settings-changes | settings changes | по токену |
GET | /audit/verify | проверить (параметры: limit) | по токену |
POST | /audit/verify-now | проверить: now (параметры: limit) | по токену |
DELETE | /compliance/contacts/{id}/forget | forget | по токену |
GET | /compliance/documents/{kind} | получить: doc | по токену |
GET | /compliance/documents/{kind}/download | скачать | по токену |
POST | /compliance/documents/{kind}/regenerate | regen | по токену |
GET | /compliance/log | log (параметры: action_type, contact_id) | по токену |
GET | /compliance/opt-outs | opt outs | по токену |
GET | /compliance/privacy/contacts | privacy contacts | по токену |
GET | /compliance/privacy/contacts/{id}/export | выгрузить: subject | по токену |
POST | /compliance/privacy/contacts/{id}/stop-marketing | остановить: marketing | по токену |
GET | /compliance/privacy/overview | privacy overview | по токену |
GET | /compliance/privacy/storage | pii storage get | по токену |
POST | /compliance/privacy/storage | pii storage set | по токену |
Биллинг (облако)
Теги OpenAPI: billing, billing-webhooks, billing-public.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
POST | /billing/cancel | cancel | по токену |
POST | /billing/checkout | checkout | по токену |
GET | /billing/invoices | invoices | по токену |
GET | /billing/plan | plan | по токену |
GET | /billing/plans | plans | по токену |
GET | /billing/public/plans | список | открытый |
GET | /billing/public/recommend | recommend | открытый |
POST | /webhooks/yookassa | receive | открытый |
Лицензия (контур)
Теги OpenAPI: license.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /admin/license | подробности | по токену |
POST | /admin/license | install | по токену |
GET | /license/status | состояние | по токену |
Администрирование платформы
Теги OpenAPI: admin-ai-providers, admin/incidents, admin-health, admin-secops, admin-csp-violations, admin-communications, demo-requests.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /admin/ai-providers | список | по токену |
POST | /admin/ai-providers | создать | по токену |
PATCH | /admin/ai-providers/{id} | изменить | по токену |
DELETE | /admin/ai-providers/{id} | удалить | по токену |
POST | /admin/ai-providers/{id}/check | проверка | по токену |
POST | /admin/ai-providers/{id}/disable | disable | по токену |
POST | /admin/ai-providers/{id}/enable | enable | по токену |
POST | /admin/ai-providers/reorder | reorder | по токену |
GET | /admin/communications | список | по токену |
GET | /admin/communications/summary | сводка | по токену |
GET | /admin/csp-violations | список | по токену |
GET | /admin/csp-violations/top-directives | top directives | по токену |
GET | /admin/demo-requests | список | открытый |
PATCH | /admin/demo-requests/{id} | set status | открытый |
GET | /admin/health/cron | cron | по токену |
GET | /admin/health/dlq | список | по токену |
DELETE | /admin/health/dlq/{queue} | discard all | по токену |
DELETE | /admin/health/dlq/{queue}/{job_id} | удалить | по токену |
POST | /admin/health/dlq/{queue}/{job_id}/retry | retry | по токену |
POST | /admin/health/dlq/{queue}/retry-all | retry all | по токену |
GET | /admin/health/retention | retention | по токену |
GET | /admin/health/secops-alerter | secops alerter | по токену |
GET | /admin/incidents | список (параметры: status) | открытый |
GET | /admin/incidents/{id} | detail | открытый |
POST | /admin/incidents/{id}/acknowledge | acknowledge | открытый |
POST | /admin/incidents/{id}/notes | note | открытый |
POST | /admin/incidents/{id}/postmortem | draft postmortem | открытый |
POST | /admin/incidents/{id}/roles | assign role | открытый |
PATCH | /admin/incidents/{id}/severity | set severity | открытый |
PATCH | /admin/incidents/{id}/status | set status | открытый |
POST | /admin/incidents/declare | declare | открытый |
GET | /admin/incidents/metrics | metrics | открытый |
GET | /admin/secops/csp-retention | получить: csp retention | по токену |
PUT | /admin/secops/csp-retention | set csp retention | по токену |
GET | /admin/secops/csp-retention/history | получить: csp retention history | по токену |
POST | /admin/secops/dry-run | dry run | по токену |
GET | /admin/secops/settings/history | получить: all history | по токену |
POST | /public/demo-request | создать | открытый |
Публичные и служебные
Теги OpenAPI: health, public/status, public/waitlist, compliance-public.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /health | проверка | открытый |
GET | /health/details | подробности | открытый |
GET | /health/live | жив ли процесс | открытый |
GET | /health/ready | готов ли принимать запросы | открытый |
GET | /public/opt-out/{token} | show | открытый |
POST | /public/opt-out/{token} | confirm | открытый |
GET | /public/status | получить: status | открытый |
GET | /public/status/components | получить: components | открытый |
GET | /public/status/incidents | получить: incidents | открытый |
POST | /public/waitlist | signup | открытый |
GET | /public/waitlist/stats | статистика | открытый |
Прочее
Теги: edition, site-visits.
| Метод | Путь | Операция | Доступ |
|---|---|---|---|
GET | /edition | получить | открытый |
GET | /site-visits | report | по токену |
3. Схемы данных
Полные схемы запросов и ответов — в openapi.json (components.schemas) и в Zod-схемах модулей API; проверка на границе отклоняет неизвестные поля.
4. Версионирование и совместимость
Префикс /v1; несовместимые изменения выходят под новым префиксом, прежний поддерживается не менее одного релиза после объявления. Изменения API описываются в журнале выпусков.