Saltar para a documentação
API

Inscrever-se através de um formulário

O endpoint para onde os visitantes de um formulário publicado enviam os dados. Não precisa de credencial, por isso chame-o a partir de um navegador ou do seu próprio servidor, de qualquer origem.

POST/subscribe/{formId}

Executa a chamada real no seu espaço de trabalho.

POST /subscribe/{formId}

O endpoint para onde os visitantes de um formulário publicado enviam os dados. Não precisa de credencial, por isso chame-o a partir de um navegador ou do seu próprio servidor, de qualquer origem.

Exemplo

Envie as respostas com a chave de cada campo como nome, no nível superior ou dentro de values. Com Accept: application/json ou um corpo JSON, a resposta é JSON. Um formulário HTML simples é antes redirecionado com um 303.

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

outcome é added quando a pessoa já está nas audiências, ou pending num formulário com dupla confirmação, em que a pessoa entra nas audiências assim que confirma por email. Esse email sai depois desta resposta, a menos que este formulário tenha enviado um email ao endereço nos últimos dez minutos ou que o endereço já tenha recebido cinco deste espaço de trabalho hoje.

Uma resposta em falta ou errada dá um 422 invalid_form_submission. O erro traz fields, uma lista de { "key", "error" } com motivos como required, email ou option.

Um formulário em pausa responde 409 form_closed, um desconhecido ou não publicado 404 form_not_found, e demasiadas inscrições a partir de uma mesma rede recebem 429 form_rate_limited. Um formulário HTML simples recebe antes um 303 para a página alojada.

As respostas a chaves que o formulário não tem são ignoradas, e as chaves que começam por oe_ nunca são guardadas. oe_source indica a página onde estava o formulário, e assume por omissão o cabeçalho Referer.

A sua caixa de entrada,
nos seus termos.

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

© 2026 OpenEmail. Todos os direitos reservados.