API v1

REST API для контактов, воронок, курсов, сайтов, продаж и сообщений. 81 методов, 10 групп.

# Первый запрос (ключ храните на вашем сервере)
curl https://<ваш-проект>.octofunnel.com/api/v1/project \
  -H "Authorization: Bearer <ключ>"
# Ответ: {data: {id, name, slug, currency, scopes}, request_id}
# Разрешение project:read; 60 запросов/мин на ключ, 300 на проект.
# 401 — неверный/отозванный ключ, 403 — недостаточно прав, 429 — лимит.

Контакт → тег

Создайте ключ с разрешениями contacts:read и contacts:write. Чтение требует текущего права CRM view; создание — CRM create; изменение — CRM edit.

curl https://<ваш-проект>.octofunnel.com/api/v1/contacts \
  -H "Authorization: Bearer <ключ>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-contact-001" \
  -d '{"values":{"name":"Alex","email":"alex@example.com"}}'

# Сохраните data.id из ответа. Пример тега — customer.
curl -X PUT https://<ваш-проект>.octofunnel.com/api/v1/contacts/<data.id>/tags/customer \
  -H "Authorization: Bearer <ключ>"

GET /contact-fields возвращает data.fields и data.variables. Записываются только зарегистрированные поля и объявленные переменные проекта. PATCH сохраняет непереданные значения; null очищает поле. Совпадение email или телефона с другим контактом возвращает 409 identity_taken.

Списки контактов и тегов: limit от 1 до 100, по умолчанию 50; следующий запрос передаёт полученный next_cursor как cursor и сохраняет фильтры. Фильтры контактов: q, email, phone, tag, channel. Email и телефон проверяются на точное нормализованное совпадение.

Правила

Авторизация	`Authorization: Bearer`. Ключ привязан к одному проекту и не превышает права владельца и тарифа. Ключи — в Интеграции → API.
Пагинация	`limit`, `cursor`, `next_cursor`.
Форматы	Даты — RFC 3339. Деньги — целые минимальные единицы и валюта.
Идемпотентность	POST-команды требуют `Idempotency-Key`: 1–128 печатных ASCII-символов, окно повтора — 24 часа в рамках проекта и операции. Другое нормализованное тело с тем же ключом — `409`.
Ревизии	Изменения контента требуют `expected_revision`. Конфликт — `409 revision_conflict`. Сайты и воронки публикуются при сохранении.
Доступ к курсам	Ручная выдача не создаёт платёж; отзыв не отменяет оплаченный доступ.
Сообщения	Только текст, по правилам подключённого канала. Принятие не означает доставку.
Ошибки	`code`, `message`, `request_id`. Лимиты — `429` с `Retry-After`.

Контекст проекта

GETproject:read

Текущий проект, язык, часовой пояс при наличии, разрешения и доступные возможности ключа · Developer

Параметры и схемы

Read the project bound to this credential

OpenAPI JSON

{
  "parameters": [],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "name",
          "slug",
          "currency",
          "scopes"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

CRM

GETcontacts:read

Список и поиск контактов; фильтры email, телефон, тег, канал; курсор · Developer

Параметры и схемы

List and search project contacts

OpenAPI JSON

{
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "maxLength": 1000
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    {
      "name": "email",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "maxLength": 255
      }
    },
    {
      "name": "phone",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "maxLength": 64
      }
    },
    {
      "name": "tag",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      }
    },
    {
      "name": "channel",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "telegram",
          "whatsapp",
          "instagram",
          "vk",
          "max",
          "messenger",
          "email",
          "web"
        ]
      }
    }
  ],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "values": {
              "type": "object",
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 4000
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "enum": [
                      "null"
                    ],
                    "nullable": true
                  }
                ]
              }
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "variables": {
              "type": "object",
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "enum": [
                      "null"
                    ],
                    "nullable": true
                  }
                ]
              }
            },
            "channels": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "telegram",
                  "whatsapp",
                  "instagram",
                  "vk",
                  "max",
                  "messenger",
                  "email",
                  "web"
                ]
              }
            },
            "created_at": {
              "type": "string",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": [
            "id",
            "name",
            "values",
            "tags",
            "variables",
            "channels",
            "created_at",
            "updated_at"
          ],
          "additionalProperties": false
        }
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      },
      "next_cursor": {
        "type": "string",
        "nullable": true
      }
    },
    "required": [
      "data",
      "request_id",
      "next_cursor"
    ],
    "additionalProperties": false
  }
}

GETcontacts:read

Карточка контакта: поля, теги, доступные для интеграции переменные · Developer

Параметры и схемы

Read a canonical contact

OpenAPI JSON

{
  "parameters": [
    {
      "name": "contact_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Opaque project-scoped contact handle"
    }
  ],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 4000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "variables": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "telegram",
                "whatsapp",
                "instagram",
                "vk",
                "max",
                "messenger",
                "email",
                "web"
              ]
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "values",
          "tags",
          "variables",
          "channels",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

POSTcontacts:write

Создать контакт · Developer

Параметры и схемы

A name or reachable/profile detail is required. Existing email/phone identities return 409; contacts are never merged automatically.

OpenAPI JSON

{
  "parameters": [
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": true,
      "description": "1–128 printable ASCII characters. Successful results are retained for 24 hours, scoped to project and operation. The same key with different normalized JSON returns 409. Replays require current authorization.",
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    }
  ],
  "request": {
    "type": "object",
    "properties": {
      "values": {
        "type": "object",
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 4000
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "enum": [
                "null"
              ],
              "nullable": true
            }
          ]
        }
      }
    },
    "required": [
      "values"
    ],
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 4000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "variables": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "telegram",
                "whatsapp",
                "instagram",
                "vk",
                "max",
                "messenger",
                "email",
                "web"
              ]
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "values",
          "tags",
          "variables",
          "channels",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

PATCHcontacts:write

Изменить только переданные поля · Developer

Параметры и схемы

Unspecified fields are preserved. Null clears a registered value. Email and phone updates use the canonical identity writer and reset verification.

OpenAPI JSON

{
  "parameters": [
    {
      "name": "contact_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Opaque project-scoped contact handle"
    }
  ],
  "request": {
    "type": "object",
    "properties": {
      "values": {
        "type": "object",
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 4000
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "enum": [
                "null"
              ],
              "nullable": true
            }
          ]
        }
      }
    },
    "required": [
      "values"
    ],
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 4000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "variables": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "telegram",
                "whatsapp",
                "instagram",
                "vk",
                "max",
                "messenger",
                "email",
                "web"
              ]
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "values",
          "tags",
          "variables",
          "channels",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

PATCHcontacts:write

Изменить переменные через `set` и `remove`, сохранив остальные · Developer

Параметры и схемы

Only project-declared variables listed by GET /contact-fields are editable. Personal fields, provider facts and system variables are excluded. Unspecified values are preserved; remove wins over set.

OpenAPI JSON

{
  "parameters": [
    {
      "name": "contact_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Opaque project-scoped contact handle"
    }
  ],
  "request": {
    "type": "object",
    "properties": {
      "set": {
        "type": "object",
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 4000
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "enum": [
                "null"
              ],
              "nullable": true
            }
          ]
        },
        "default": {}
      },
      "remove": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 160
        },
        "maxItems": 100,
        "default": []
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 4000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "variables": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "enum": [
                    "null"
                  ],
                  "nullable": true
                }
              ]
            }
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "telegram",
                "whatsapp",
                "instagram",
                "vk",
                "max",
                "messenger",
                "email",
                "web"
              ]
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "values",
          "tags",
          "variables",
          "channels",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

GETcontacts:read

Схема доступных стандартных и пользовательских полей · Developer

Параметры и схемы

List editable fields and available variable names

OpenAPI JSON

{
  "parameters": [],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "text",
                    "textarea",
                    "number",
                    "date",
                    "boolean",
                    "email",
                    "tel"
                  ]
                },
                "group": {
                  "type": "string",
                  "enum": [
                    "basic",
                    "social",
                    "details",
                    "custom"
                  ]
                },
                "labelKey": {
                  "type": "string"
                },
                "profileBase": {
                  "type": "string"
                },
                "channel": {
                  "type": "string"
                }
              },
              "required": [
                "key",
                "label",
                "type",
                "group"
              ],
              "additionalProperties": false
            }
          },
          "variables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "fields",
          "variables"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

POSTcontacts:write

Создать пользовательское поле проекта · Developer

Параметры и схемы

At most 50 definitions per project. Duplicate normalized labels return 409.

OpenAPI JSON

{
  "parameters": [
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": true,
      "description": "1–128 printable ASCII characters. Successful results are retained for 24 hours, scoped to project and operation. The same key with different normalized JSON returns 409. Replays require current authorization.",
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    }
  ],
  "request": {
    "type": "object",
    "properties": {
      "label": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "type": {
        "type": "string",
        "enum": [
          "text",
          "textarea",
          "number",
          "date",
          "boolean"
        ]
      }
    },
    "required": [
      "label",
      "type"
    ],
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "textarea",
              "number",
              "date",
              "boolean"
            ]
          },
          "key": {
            "type": "string",
            "pattern": "^custom_[a-f0-9]{24}$"
          }
        },
        "required": [
          "label",
          "type",
          "key"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

GETcontacts:read

Каталог CRM-тегов · Developer

Параметры и схемы

List CRM tag catalog entries

OpenAPI JSON

{
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "maxLength": 1000
      }
    }
  ],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "key": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "color": {
              "type": "string",
              "pattern": "^#[0-9a-f]{6}$"
            }
          },
          "required": [
            "key",
            "color"
          ],
          "additionalProperties": false
        }
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      },
      "next_cursor": {
        "type": "string",
        "nullable": true
      }
    },
    "required": [
      "data",
      "request_id",
      "next_cursor"
    ],
    "additionalProperties": false
  }
}

POSTcontacts:write

Создать тег · Developer

Параметры и схемы

Tag keys are case-sensitive. This is the CRM catalog; case tags are separate. Existing keys return 409.

OpenAPI JSON

{
  "parameters": [
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": true,
      "description": "1–128 printable ASCII characters. Successful results are retained for 24 hours, scoped to project and operation. The same key with different normalized JSON returns 409. Replays require current authorization.",
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    }
  ],
  "request": {
    "type": "object",
    "properties": {
      "key": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "color": {
        "type": "string",
        "pattern": "^#[0-9a-f]{6}$"
      }
    },
    "required": [
      "key",
      "color"
    ],
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "color": {
            "type": "string",
            "pattern": "^#[0-9a-f]{6}$"
          }
        },
        "required": [
          "key",
          "color"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

PUTcontacts:write

Идемпотентно назначить тег · Developer

Параметры и схемы

Idempotently assign one CRM tag

OpenAPI JSON

{
  "parameters": [
    {
      "name": "contact_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Opaque project-scoped contact handle"
    },
    {
      "name": "tag_key",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Case-sensitive tag key, URL-encoded"
    }
  ],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "tags"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

DELETEcontacts:write

Снять конкретный тег · Developer

Параметры и схемы

Idempotently remove one CRM tag

OpenAPI JSON

{
  "parameters": [
    {
      "name": "contact_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Opaque project-scoped contact handle"
    },
    {
      "name": "tag_key",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Case-sensitive tag key, URL-encoded"
    }
  ],
  "response": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "tags"
        ],
        "additionalProperties": false
      },
      "request_id": {
        "type": "string",
        "format": "uuid"
      }
    },
    "required": [
      "data",
      "request_id"
    ],
    "additionalProperties": false
  }
}

Воронки, графы и участие контакта

GETfunnels:read

Список доступных воронок · В разработке

GETfunnels:read

Метаданные и допустимые CRM-этапы, без внутреннего графа · В разработке

POSTfunnels:write

Создать воронку поддерживаемого вида · В разработке

PATCHfunnels:write

Изменить доступные для автора метаданные воронки · В разработке

GETfunnels:read

Прочитать редактируемый граф: узлы, связи и настройки · В разработке

PUTfunnels:write

Заменить граф с проверкой схемы и ревизии · В разработке

GETfunnels:read

Список доступных контрольных точек графа · В разработке

POSTfunnels:write

Восстановить граф из контрольной точки новой ревизией · В разработке

GETfunnels:read

Участие контакта в воронках и текущие CRM-этапы · В разработке

POSTfunnels:enroll

Подключить к существующей воронке · В разработке

PATCHfunnels:manage

Сменить допустимый CRM-этап · В разработке

DELETEfunnels:manage

Прекратить участие в выбранной воронке · В разработке

Курсы, модули, уроки и доступы

GETcourses:read

Список курсов · В разработке

GETcourses:read

Метаданные, доступные варианты доступа и потоки · В разработке

POSTcourses:write

Создать курс · В разработке

PATCHcourses:write

Изменить название, описание, обложку и поддерживаемые настройки курса · В разработке

GETcourses:read

Список модулей и их порядок · В разработке

POSTcourses:write

Создать модуль · В разработке

PATCHcourses:write

Изменить метаданные модуля · В разработке

PUTcourses:write

Задать порядок модулей · В разработке

GETcourses:read

Список уроков, принадлежность модулям и порядок · В разработке

GETcourses:read

Метаданные одного урока · В разработке

POSTcourses:write

Создать урок, при необходимости в выбранном модуле · В разработке

PATCHcourses:write

Изменить метаданные, модуль и поддерживаемые настройки урока · В разработке

GETcourses:read

Прочитать блоки и сведения о ревизиях содержимого урока · В разработке

PUTcourses:write

Заменить блоки урока с проверкой ревизии · В разработке

POSTcourses:publish

Опубликовать конкретную проверенную ревизию содержимого урока · В разработке

PUTcourses:write

Задать порядок уроков с сохранением связи с модулями · В разработке

GETcourses:read

Доступные контрольные точки содержимого урока · В разработке

POSTcourses:write

Восстановить содержимое урока новой ревизией · В разработке

GETcourses:read

Прочитать общие секции, используемые уроками курса · В разработке

PUTcourses:write

Обновить общие секции с проверкой ревизии · В разработке

GETcourse-access:read

Действующие доступы контакта с источником и сроками · В разработке

POSTcourse-access:grant

Выдать ручной доступ к существующему варианту курса/потока · В разработке

DELETEcourse-access:revoke

Отозвать конкретный ручной доступ · В разработке

Каталог предложений

GETcatalog:read

Товары, варианты, цены и доступность · В разработке

GETcatalog:read

Один товар с вариантами · В разработке

GETcatalog:read

Клиентские тарифные предложения проекта · В разработке

GETcatalog:read

Одно тарифное предложение · В разработке

Продажи

GETsales:read

Заказы продаж бизнеса; фильтры contact, status; курсор · В разработке

GETsales:read

Состав, сумма, валюта и статус конкретного заказа · В разработке

GETsales:read

Подписки покупателей бизнеса клиента · В разработке

GETsales:read

Состояние одной подписки · В разработке

Сообщения

GETchannels:read

Подключённые каналы и доступные операции без секретов · В разработке

GETmessages:read

История сообщений с курсором · В разработке

POSTmessages:send

Отправить текст существующему контакту через разрешённый подключённый канал · В разработке

Подписки интеграций на события

GETwebhooks:read

Список адресов доставки и подписок на типы событий · В разработке

GETwebhooks:read

Настройки одной подписки без секрета подписи · В разработке

POSTwebhooks:write

Создать адрес доставки и выбрать события · В разработке

PATCHwebhooks:write

Сменить URL, события или приостановить доставку · В разработке

DELETEwebhooks:write

Удалить подписку · В разработке

GETwebhooks:read

Ограниченный журнал попыток и ошибок · В разработке

POSTwebhooks:write

Повторить доставку сохранённого события · В разработке

Сайты и страницы

GETsites:read

Список сайтов проекта · В разработке

GETsites:read

Метаданные и поддерживаемые настройки сайта · В разработке

POSTsites:write

Создать сайт · В разработке

PATCHsites:write

Изменить название, slug, оформление и поддерживаемые настройки · В разработке

GETsites:read

Список страниц, вложенность, порядок и признак главной · В разработке

GETsites:read

Метаданные страницы · В разработке

POSTsites:write

Создать страницу, при необходимости вложенную · В разработке

PATCHsites:write

Изменить метаданные, SEO-поля и положение страницы в иерархии · В разработке

GETsites:read

Прочитать блоки страницы и ревизию · В разработке

PUTsites:write

Заменить блоки страницы с проверкой ревизии · В разработке

PUTsites:write

Задать порядок страниц с сохранением иерархии · В разработке

GETsites:read

Прочитать общие секции сайта · В разработке

PUTsites:write

Обновить общие секции с проверкой ревизии · В разработке

GETsites:read

Доступные контрольные точки содержимого страницы · В разработке

POSTsites:write

Восстановить содержимое страницы новой ревизией · В разработке

Схемы авторского контента

GETauthoring:read

Поддерживаемые для ключа виды воронок, типы узлов/блоков, версии схем и ссылки на их описание · В разработке