In this area
Forms
5 tools
create_form
Write
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.
- Permission
forms:write- Operation
forms.create- Module
forms
Parameters
namestringrequireddescriptionstringoptionalfieldsobject[]required- Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo.
fields[].labelstringrequiredfields[].typestringrequiredTEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDENfields[].keystringoptional- Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar.
fields[].requiredbooleanoptionalfields[].optionsstring[]optionalfields[].placeholderstringoptionalfields[].helpTextstringoptionalfields[].saveTostringoptional- Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).
namefirstNamelastNameemailphonecitystatecountry fields[].saveAsCustomFieldbooleanoptional- Sem saveTo: guarda a resposta num campo personalizado do contato.
statusstringoptionalDRAFTACTIVEsuccessMessagestringoptionalredirectUrlstring (uri)optional- Página para onde a pessoa vai depois de enviar.
| Field | Type | Description |
|---|---|---|
namerequired | string | |
descriptionoptional | string | |
fieldsrequired | object[] | Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo. |
fields[].labelrequired | string | |
fields[].typerequired | string | TEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDEN |
fields[].keyoptional | string | Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar. |
fields[].requiredoptional | boolean | |
fields[].optionsoptional | string[] | |
fields[].placeholderoptional | string | |
fields[].helpTextoptional | string | |
fields[].saveTooptional | string | Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).namefirstNamelastNameemailphonecitystatecountry |
fields[].saveAsCustomFieldoptional | boolean | Sem saveTo: guarda a resposta num campo personalizado do contato. |
statusoptional | string | DRAFTACTIVE |
successMessageoptional | string | |
redirectUrloptional | string (uri) | Página para onde a pessoa vai depois de enviar. |
get_form
Read
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.
- Permission
forms:read- Operation
forms.get- Module
forms
Parameters
formIdstringrequired
| Field | Type | Description |
|---|---|---|
formIdrequired | string |
list_form_submissions
Read
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.
- Permission
forms:read- Operation
forms.submissions.list- Module
forms
Parameters
formIdstringoptionalcontactIdstringoptionaldateFromstringoptional- AAAA-MM-DD (Brasília).
dateTostringoptional- AAAA-MM-DD, inclusivo.
pageintegeroptionallimitintegeroptional
| Field | Type | Description |
|---|---|---|
formIdoptional | string | |
contactIdoptional | string | |
dateFromoptional | string | AAAA-MM-DD (Brasília). |
dateTooptional | string | AAAA-MM-DD, inclusivo. |
pageoptional | integer | |
limitoptional | integer |
list_forms
Read
Formulários de captação da empresa: nome, status (DRAFT rascunho, ACTIVE recebendo respostas, ARCHIVED), link público e quantas respostas já recebeu.
- Permission
forms:read- Operation
forms.list- Module
forms
Parameters
statusstringoptionalDRAFTACTIVEARCHIVED
| Field | Type | Description |
|---|---|---|
statusoptional | string | DRAFTACTIVEARCHIVED |
update_form
Write
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.
- Permission
forms:write- Operation
forms.update- Module
forms
Parameters
formIdstringrequirednamestringoptionaldescriptionstringoptionalstatusstringoptionalDRAFTACTIVEARCHIVEDfieldsobject[]optional- Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo.
fields[].labelstringrequiredfields[].typestringrequiredTEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDENfields[].keystringoptional- Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar.
fields[].requiredbooleanoptionalfields[].optionsstring[]optionalfields[].placeholderstringoptionalfields[].helpTextstringoptionalfields[].saveTostringoptional- Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).
namefirstNamelastNameemailphonecitystatecountry fields[].saveAsCustomFieldbooleanoptional- Sem saveTo: guarda a resposta num campo personalizado do contato.
successMessagestringoptionalredirectUrlstring (uri)optional- Página para onde a pessoa vai depois de enviar.
| Field | Type | Description |
|---|---|---|
formIdrequired | string | |
nameoptional | string | |
descriptionoptional | string | |
statusoptional | string | DRAFTACTIVEARCHIVED |
fieldsoptional | object[] | Perguntas, na ordem. Para o contato virar lead, peça telefone ou e-mail com saveTo. |
fields[].labelrequired | string | |
fields[].typerequired | string | TEXTEMAILPHONENUMBERSELECTTEXTAREACHECKBOXRADIOHIDDEN |
fields[].keyoptional | string | Chave nas respostas (padrão: tirada do rótulo). Mantenha a mesma ao editar. |
fields[].requiredoptional | boolean | |
fields[].optionsoptional | string[] | |
fields[].placeholderoptional | string | |
fields[].helpTextoptional | string | |
fields[].saveTooptional | string | Grava a resposta no cadastro do contato (nome, e-mail, telefone, cidade…).namefirstNamelastNameemailphonecitystatecountry |
fields[].saveAsCustomFieldoptional | boolean | Sem saveTo: guarda a resposta num campo personalizado do contato. |
successMessageoptional | string | |
redirectUrloptional | string (uri) | Página para onde a pessoa vai depois de enviar. |