Nesta área
Formulários
5 ferramentas
create_form
Escrita
Cria um formulário de captação. Nasce em rascunho (DRAFT); com status ACTIVE o link público já recebe respostas, e cada resposta cria ou atualiza o contato. Devolve o link público.
- Permissão
forms:write- Operação
forms.create- Módulo
forms
Parâmetros
namestringobrigatóriodescriptionstringopcionalfieldsobject[]obrigatório- Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo.
fields[].labelstringobrigatóriofields[].typestringobrigatórioTEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDENfields[].keystringopcional- Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar.
fields[].requiredbooleanopcionalfields[].optionsstring[]opcionalfields[].placeholderstringopcionalfields[].helpTextstringopcionalfields[].saveTostringopcional- Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).
namefirstNamelastNameemailphonecitystatecountry fields[].saveAsCustomFieldbooleanopcional- Sem saveTo: guarda a resposta num campo personalizado do contato.
statusstringopcionalDRAFTACTIVEsuccessMessagestringopcionalredirectUrlstring (uri)opcional- Página para onde a pessoa vai depois de enviar.
| Campo | Tipo | Descrição |
|---|---|---|
nameobrigatório | string | |
descriptionopcional | string | |
fieldsobrigatório | object[] | Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo. |
fields[].labelobrigatório | string | |
fields[].typeobrigatório | string | TEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDEN |
fields[].keyopcional | string | Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar. |
fields[].requiredopcional | boolean | |
fields[].optionsopcional | string[] | |
fields[].placeholderopcional | string | |
fields[].helpTextopcional | string | |
fields[].saveToopcional | string | Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).namefirstNamelastNameemailphonecitystatecountry |
fields[].saveAsCustomFieldopcional | boolean | Sem saveTo: guarda a resposta num campo personalizado do contato. |
statusopcional | string | DRAFTACTIVE |
successMessageopcional | string | |
redirectUrlopcional | string (uri) | Página para onde a pessoa vai depois de enviar. |
get_form
Leitura
Um formulário: perguntas (chave, rótulo, tipo, obrigatória, opções e onde a resposta é gravada no contato), link público, mensagem de sucesso e redirecionamento.
- Permissão
forms:read- Operação
forms.get- Módulo
forms
Parâmetros
formIdstringobrigatório
| Campo | Tipo | Descrição |
|---|---|---|
formIdobrigatório | string |
list_form_submissions
Leitura
Respostas recebidas (leads), mais recentes primeiro: de um formulário ou de todos, por período ou de um contato. Cada resposta vem com o formulário, o contato criado/atualizado e as respostas pelo texto da pergunta.
- Permissão
forms:read- Operação
forms.submissions.list- Módulo
forms
Parâmetros
formIdstringopcionalcontactIdstringopcionaldateFromstringopcional- AAAA-MM-DD (Brasília).
dateTostringopcional- AAAA-MM-DD, inclusivo.
pageintegeropcionallimitintegeropcional
| Campo | Tipo | Descrição |
|---|---|---|
formIdopcional | string | |
contactIdopcional | string | |
dateFromopcional | string | AAAA-MM-DD (Brasília). |
dateToopcional | string | AAAA-MM-DD, inclusivo. |
pageopcional | integer | |
limitopcional | integer |
list_forms
Leitura
Formulários de captação da empresa: nome, status (DRAFT rascunho, ACTIVE recebendo respostas, ARCHIVED), link público e quantas respostas já recebeu.
- Permissão
forms:read- Operação
forms.list- Módulo
forms
Parâmetros
statusstringopcionalDRAFTACTIVEARCHIVED
| Campo | Tipo | Descrição |
|---|---|---|
statusopcional | string | DRAFTACTIVEARCHIVED |
update_form
Escrita
Edita um formulário: nome, descrição, status (ACTIVE publica, DRAFT/ARCHIVED param de receber), mensagem de sucesso, redirecionamento ou as perguntas. `fields` troca a lista inteira: mande todas, mantendo a `key` das que já existem para não separar respostas antigas.
- Permissão
forms:write- Operação
forms.update- Módulo
forms
Parâmetros
formIdstringobrigatórionamestringopcionaldescriptionstringopcionalstatusstringopcionalDRAFTACTIVEARCHIVEDfieldsobject[]opcional- Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo.
fields[].labelstringobrigatóriofields[].typestringobrigatórioTEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDENfields[].keystringopcional- Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar.
fields[].requiredbooleanopcionalfields[].optionsstring[]opcionalfields[].placeholderstringopcionalfields[].helpTextstringopcionalfields[].saveTostringopcional- Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).
namefirstNamelastNameemailphonecitystatecountry fields[].saveAsCustomFieldbooleanopcional- Sem saveTo: guarda a resposta num campo personalizado do contato.
successMessagestringopcionalredirectUrlstring (uri)opcional- Página para onde a pessoa vai depois de enviar.
| Campo | Tipo | Descrição |
|---|---|---|
formIdobrigatório | string | |
nameopcional | string | |
descriptionopcional | string | |
statusopcional | string | DRAFTACTIVEARCHIVED |
fieldsopcional | object[] | Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo. |
fields[].labelobrigatório | string | |
fields[].typeobrigatório | string | TEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDEN |
fields[].keyopcional | string | Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar. |
fields[].requiredopcional | boolean | |
fields[].optionsopcional | string[] | |
fields[].placeholderopcional | string | |
fields[].helpTextopcional | string | |
fields[].saveToopcional | string | Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).namefirstNamelastNameemailphonecitystatecountry |
fields[].saveAsCustomFieldopcional | boolean | Sem saveTo: guarda a resposta num campo personalizado do contato. |
successMessageopcional | string | |
redirectUrlopcional | string (uri) | Página para onde a pessoa vai depois de enviar. |