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

Подписка через форму

Эндпоинт, на который отправляют данные посетители опубликованной формы. Учётные данные ему не нужны, поэтому вызывайте его из браузера или со своего сервера, с любого источника.

POST/subscribe/{formId}

Выполняет настоящий запрос в вашем рабочем пространстве.

POST /subscribe/{formId}

Эндпоинт, на который отправляют данные посетители опубликованной формы. Учётные данные ему не нужны, поэтому вызывайте его из браузера или со своего сервера, с любого источника.

Пример

Отправляйте ответы с ключами полей, на верхнем уровне или внутри values. С Accept: application/json или с телом в JSON ответ приходит в JSON. Обычная HTML-форма вместо этого перенаправляется с кодом 303.

curl
curl -X POST "$OE/subscribe/frm_3b9d2e7a1c4f80d56e2a9b14" -H 'content-type: application/json' -d '{  "email": "[email protected]",  "first_name": "Ann",  "consent": true}'
Ответ
{  "object": "form_subscription",  "formId": "frm_3b9d2e7a1c4f80d56e2a9b14",  "outcome": "pending",  "redirectUrl": null}

outcome равен added, когда человек уже в аудиториях, или pending в форме с двойным подтверждением, где он вступает в аудитории, как только подтвердит подписку по почте. Это письмо уходит после этого ответа, кроме случаев, когда эта форма уже отправляла письмо на этот адрес за последние десять минут или когда на этот адрес сегодня уже ушло пять писем из этого рабочего пространства.

Отсутствующий или неверный ответ даёт 422 invalid_form_submission. Ошибка содержит fields, список { "key", "error" } с причинами, такими как required, email или option.

Приостановленная форма отвечает 409 form_closed, неизвестная или неопубликованная отвечает 404 form_not_found, а на слишком много подписок из одной сети приходит 429 form_rate_limited. Обычная HTML-форма вместо этого получает 303 с перенаправлением на размещённую у нас страницу.

Ответы на ключи, которых нет в форме, игнорируются, а ключи, начинающиеся с oe_, никогда не сохраняются. oe_source называет страницу, на которой была форма, и по умолчанию берётся из заголовка Referer.

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

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