Pular para o conteúdo principal
PUT
Configurar Formulário Instantâneo

Autorizações

x-api-key
string
header
obrigatório

Sua chave de API ps_

Cabeçalhos

x-whatsapp-number-id
string

Restringe uma credencial da conta inteira a um número (o id dele ou o id da instância, de GET /v1/numbers). Sem ele, uma credencial da conta inteira vê o workspace todo; uma chave com escopo de número vê sempre só o próprio número.

Parâmetros de caminho

O id do vínculo (linked[].pageLinkId de GET /v1/lead-pages), não o id da Página do Facebook.

formId
string
obrigatório

Id numérico do Formulário Instantâneo (forms[].formId).

Corpo

application/json

key da caixa de consentimento (consentCheckboxes[].key). Obrigatória para o envio automático.

Exemplo:

"whatsapp_optin"

autoSendEnabled
boolean
obrigatório

Mandar mensagem automaticamente a todo lead novo do formulário.

Exemplo:

true

templateId
string | null
obrigatório

Números oficiais: um template APROVADO do número (templates[].id). Deve ser null em números não oficiais.

Exemplo:

null

freeText
string | null
obrigatório

Números não oficiais: a mensagem, com variáveis {{nome}}. Deve ser null em números oficiais.

Maximum string length: 4096
Exemplo:

"Olá {{nome}}, recebemos seu pedido de orçamento!"

variableMap
object

Valor de cada variável do template ou do texto: { "source": "field", "key": "<chave da pergunta>" } ou { "source": "static", "value": "..." }. Padrão {}.

Exemplo:
formName
string | null

Rótulo opcional do formulário.

Maximum string length: 255
Exemplo:

"Orçamento — Outubro"

Resposta

Configuração salva