Saltar para a documentação
CLI

Formulários de inscrição

Cada comando dos formulários de inscrição e das pessoas que os preenchem, com exemplos práticos.

Como tudo se encaixa

Um formulário de inscrição adiciona às suas audiências as pessoas que o preenchem. Guarda um rascunho e uma cópia ativa: update altera o rascunho e as definições, e publish ativa o rascunho. Ler requer forms:read e alterar requer forms:write. resend-confirmation requer também emails:send, tal como qualquer alteração que faça o formulário enviar correio.

Terminal
openemail forms create --name "Newsletter sign-up" --starter newsletter --publishopenemail forms list-submissions frm_3b9d2e7a1c4f80d56e2a9b14 --status pendingopenemail forms analytics frm_3b9d2e7a1c4f80d56e2a9b14 --days 30

Formulários

ComandoO que faz
openemail forms listUma página dos formulários, dos mais recentes para os mais antigos, com o estado e os números de cada um
openemail forms create --name <value>Criar um rascunho a partir de --starter, de um ficheiro --document ou de um único campo de email. --publish ativa-o de imediato
openemail forms get <id>Um formulário com o rascunho, a cópia ativa e as definições
openemail forms update <id>Alterar o nome, o rascunho --document ou quaisquer definições, como --settings-double-opt-in, numa só chamada
openemail forms publish <id>Ativar o rascunho
openemail forms pause <id>Fazer com que um formulário publicado deixe de aceitar inscrições
openemail forms resume <id>Voltar a abrir um formulário em pausa
openemail forms duplicate <id>Copiar um formulário para um novo rascunho, sem as suas inscrições
openemail forms delete <id>Eliminar um formulário e as suas inscrições depois de confirmar. Um início de sessão no navegador pede também um código de verificação
openemail forms list-startersOs pontos de partida a partir dos quais um novo formulário pode começar
openemail forms get-starter <slug>Um ponto de partida com o seu documento
openemail forms analytics <id>Visualizações, inscrições e pessoas adicionadas num período, de 30 dias a menos que --days ou --minutes indiquem outra coisa

Submissões

ComandoO que faz
openemail forms list-submissions <id>Uma página de inscrições, das mais recentes para as mais antigas. --q pesquisa endereços de email e --status escolhe pending ou added
openemail forms get-submission <id> <submission-id>Uma inscrição com todas as respostas
openemail forms delete-submission <id> <submission-id>Eliminar uma inscrição depois de confirmar. A pessoa fica nos seus contactos
openemail forms delete-submissions <id> <submission-ids...>Eliminar até 200 inscrições depois de confirmar
openemail forms approve-submission <id> <submission-id>Adicionar uma inscrição pendente sem a sua confirmação. Requer também contacts:write
openemail forms resend-confirmation <id> <submission-id>Enviar por email uma nova ligação de confirmação a uma inscrição pendente, a menos que já tenha saído uma nos últimos dez minutos. Requer também emails:send

Inscrever alguém

subscribe envia dados por POST para um formulário publicado, tal como a página dele faz. Não precisa de chave nem de início de sessão, por isso funciona sem sessão iniciada. Passe as outras respostas como JSON com --data, e a página onde estava o formulário com --oe-source.

Terminal
openemail forms subscribe frm_3b9d2e7a1c4f80d56e2a9b14 --email [email protected] --data '{"first_name":"Ann","consent":true}'

Uma resposta em falta ou errada sai com o código 7 e lista cada campo com o respetivo motivo. Um formulário em pausa sai com 6, e demasiadas inscrições a partir de uma mesma rede com 8.

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.