Перейти к документации
CLI

Формы подписки

Каждая команда для форм подписки и людей, которые их заполняют, с разобранными примерами.

Как всё связано

Форма подписки добавляет заполнивших её людей в ваши аудитории. Она хранит черновик и опубликованную копию: update меняет черновик и настройки, а publish публикует черновик. Для чтения нужен forms:read, а для изменения нужен forms:write. Для resend-confirmation, как и для любого изменения, которое заставляет форму отправлять почту, нужен также emails:send.

Терминал
openemail forms create --name "Newsletter sign-up" --starter newsletter --publishopenemail forms list-submissions frm_3b9d2e7a1c4f80d56e2a9b14 --status pendingopenemail forms analytics frm_3b9d2e7a1c4f80d56e2a9b14 --days 30

Формы

КомандаЧто делает
openemail forms listОдна страница форм, от новых к старым, с их статусом и показателями
openemail forms create --name <value>Создать черновик из --starter, из файла --document или с одним полем эл. почты. --publish сразу публикует его
openemail forms get <id>Одна форма с её черновиком, опубликованной копией и настройками
openemail forms update <id>Изменить название, черновик --document или любые настройки, например --settings-double-opt-in, одним вызовом
openemail forms publish <id>Опубликовать черновик
openemail forms pause <id>Прекратить приём подписок опубликованной формой
openemail forms resume <id>Снова открыть приостановленную форму
openemail forms duplicate <id>Скопировать форму в новый черновик без её подписок
openemail forms delete <id>Удалить форму и её подписки после того, как вы подтвердите. При входе через браузер также запрашивается код подтверждения
openemail forms list-startersЗаготовки, с которых может начинаться новая форма
openemail forms get-starter <slug>Одна заготовка с её документом
openemail forms analytics <id>Просмотры, подписки и добавленные люди за период, 30 дней, если --days или --minutes не говорит иначе

Заявки

КомандаЧто делает
openemail forms list-submissions <id>Одна страница подписок, от новых к старым. --q ищет по адресам электронной почты, а --status выбирает pending или added
openemail forms get-submission <id> <submission-id>Одна подписка со всеми ответами
openemail forms delete-submission <id> <submission-id>Удалить одну подписку после того, как вы подтвердите. Человек остаётся в ваших контактах
openemail forms delete-submissions <id> <submission-ids...>Удалить до 200 подписок после того, как вы подтвердите
openemail forms approve-submission <id> <submission-id>Добавить ожидающую подписку без её подтверждения. Нужен также contacts:write
openemail forms resend-confirmation <id> <submission-id>Отправить по ожидающей подписке письмо с новой ссылкой для подтверждения, если такое письмо не уходило за последние десять минут. Нужен также emails:send

Как подписать человека

subscribe отправляет данные в опубликованную форму так же, как её страница. Ему не нужны ни ключ, ни вход, поэтому он работает и без входа. Передайте остальные ответы в JSON через --data, а страницу, на которой была форма, через --oe-source.

Терминал
openemail forms subscribe frm_3b9d2e7a1c4f80d56e2a9b14 --email [email protected] --data '{"first_name":"Ann","consent":true}'

При отсутствующем или неверном ответе команда завершается с кодом 7 и перечисляет каждое поле с причиной. Для приостановленной формы код выхода 6, а при слишком большом числе подписок из одной сети 8.

Ваши входящие,
на ваших условиях.

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