Перейти к основному содержимому

Управление участниками сценария через API

При работе с автоматическими сценариями вы можете управлять их участниками с помощью Sendsay API.

Важно

Перед началом работы убедитесь, что ваш сценарий активирован, а приём подписчиков включён.

Как настроить и активировать сценарий

При добавлении подписчиков в сценарий указанные пользователи начнут его прохождение, минуя Стартовое событие.

Как добавить или исключить подписчика из сценария​

Перейдите в API-консоль и введите запрос:

{
  "action": "sequence.member.start",
  "id": "id сценария",
  "email": "email подписчика"
}

где email подписчика — адрес добавляемого подписчика, id сценария — ID активированного сценария, его можно посмотреть на странице сценария:

Workflow ID

Нажмите «Выполнить».

Как добавить или исключить из сценария нескольких подписчиков​

Перейдите в API-консоль и введите запрос:

{
  "action": "sequence.member.start",
  "id": "id сценария",
  "list" : [
            "email подписчика",
            "email подписчика",
            "email подписчика",
           ]
}

где id сценария — ID активированного сценария, email подписчика — адреса подписчиков, которых необходимо добавить в сценарий. Внутри list может быть сколько угодно адресов, указанных через запятую.

Нажмите «Выполнить».

Как добавить или исключить из сценария список или сегмент подписчиков​

Перейдите в API-консоль и введите запрос:

{
  "action": "sequence.member.start",
  "id": "id_сценария",
  "group": "id списка или сегмента"
}

где id сценария — ID активированного сценария, id списка или сегмента — ID списка или сегмента c подписчиками, который можно посмотреть на его странице:

List ID

Нажмите «Выполнить».

Если вы хотите отправлять API-запросы с вашего сервера, вам понадобится API-ключ.

Описание в документации к API

Читайте также: Гайд по работе со сценариями