Formulários
Formulários de inscrição, as pessoas que os preenchem e os respetivos números.
Ferramentas de formulários
| Ferramenta | O que faz |
|---|---|
| listForms | Os formulários de inscrição do espaço de trabalho, primeiro os alterados mais recentemente, com o estado, as inscrições e as visualizações de cada um. |
| getForm | Um formulário por inteiro: os campos, os textos, as audiências, a dupla confirmação e as notificações. Um formulário publicado acrescenta a ligação, o código de incorporação e o endereço para onde um formulário HTML simples envia os dados, e includeDesign devolve o rascunho como JSON. |
| listFormStarters | Os pontos de partida a partir dos quais um novo formulário pode começar, com os campos que cada um pede. |
| createForm | Criar um formulário a partir de um ponto de partida, de um design escrito como document, ou de um ponto de partida com alterações por cima, com quaisquer definições. Fica como rascunho a menos que publish seja true. |
| updateForm | Alterar o nome e as definições de um formulário, que se aplicam de imediato, ou o design do seu rascunho através de document. Os textos e o estilo são fundidos chave a chave, e fields substitui a lista inteira. |
| publishForm | Fazer do rascunho atual aquilo que os visitantes veem, para que o formulário aceite inscrições. |
| setFormStatus | Pausar um formulário publicado, ou voltar a abri-lo. |
| duplicateForm | Copiar um formulário para um novo rascunho, sem as suas inscrições. |
| deleteForm | Eliminar de vez um formulário e as suas inscrições. A ligação e as incorporações deixam de funcionar, e as pessoas que adicionou ficam nos seus contactos. |
| getFormAnalytics | Visualizações, inscrições, pessoas adicionadas e ainda à espera, e a taxa de conversão num período, no total e por minuto, hora ou dia. As visualizações são guardadas por hora. |
| listFormSubmissions | As pessoas que preencheram um formulário, das mais recentes para as mais antigas, com as respostas e o estado, uma página de cada vez. Permite pesquisar por endereço de email e filtrar por estado. |
| getFormSubmission | Uma inscrição por inteiro: cada resposta, o estado, quando chegou e quando a pessoa foi adicionada, a página de onde veio e as suas audiências. |
| approveFormSubmission | Adicionar uma inscrição que está à espera da confirmação, sem o email. Requer também contacts:write. |
| resendFormConfirmation | Enviar por email uma nova ligação de confirmação a uma inscrição ainda à espera. Nada é enviado quando este formulário já enviou um email a esse endereço nos últimos dez minutos, ou quando o endereço já recebeu cinco deste espaço de trabalho no último dia. Requer também emails:send. |
| removeFormSubmissions | Eliminar até 200 inscrições de um formulário por id. Os contactos e as audiências ficam como estão. |
Ler requer forms:read e cada alteração requer forms:write. Tudo o que faz um formulário enviar correio requer também emails:send: ativar a dupla confirmação, definir o remetente ou o email de confirmação, publicar ou voltar a abrir um formulário com dupla confirmação, e reenviar uma confirmação. Um cliente que age por um membro só vê os formulários que esse membro criou, e um cliente limitado a alguns endereços só pode enviar confirmações a partir de endereços que consegue alcançar, e só pode notificar esses endereços.
Conceber um formulário a partir de uma descrição escrita faz-se no chat da aplicação. Através do MCP, o designer é o cliente: passe os campos, os textos e o estilo como document a createForm ou updateForm, e as ferramentas arrumam o design e dizem o que alteraram.
Sete ferramentas deste servidor fazem uma alteração que a API REST protege com um código de verificação, e pedem o mesmo código: createRule, setRuleEnabled, removeDomain, removeDomainAddress, removeAppHost, deleteForm e deleteAudience numa audiência que criou. Enquanto o cliente não tiver verificado um código nos últimos 60 minutos, e a pessoa não tiver escolhido Permitir alterações durante 60 minutos para ele em Conta → Aplicações ligadas, essa ferramenta responde com um resultado que começa por Refused (step_up_required): e não altera nada. emptyAudience nunca pede um código. A página Autenticação da API mostra como pedir um código e verificá-lo.
As ferramentas aplicam as mesmas regras e recusas que a API REST, e as páginas /forms da referência da API descrevem cada campo. listForms ordena pela última alteração, e createForm e updateForm arrumam um document parcial, enquanto a API o recebe por inteiro.
