Ads
Configure an Instant Form
Creates or replaces one form’s configuration: which consent checkbox means “may message me on WhatsApp”, and whether every new lead of the form gets an automatic WhatsApp message — sent by Pilot Status without a human, so a configuration this endpoint accepts will message leads.
Send the whole object. Rules: auto-send requires consentDisclaimerKey (400 CONSENT_REQUIRED). On an official number the message is an APPROVED template of the number (templateId; 400 TEMPLATE_REQUIRED, TEMPLATE_NOT_ELIGIBLE, FREE_TEXT_NOT_ALLOWED). On an unofficial number it is freeText with {{name}} placeholders (400 FREE_TEXT_REQUIRED, TEMPLATE_NOT_ALLOWED; a placeholder with spaces is refused as VALIDATION_FAILED with INVALID_PLACEHOLDER). Every variable must be mapped in variableMap to a form answer ({ "source": "field", "key": "<question key>" }) or a fixed value ({ "source": "static", "value": "..." }) — otherwise 400 VARIABLES_UNMAPPED with missingVariables. The message rules apply only with autoSendEnabled: true, so you can save the consent checkbox and a draft first.
OAuth/MCP tokens need integrations:manage (workspace ADMIN or OWNER) on every verb, reads included. Scope: a number-scoped key, or an account-wide credential with x-whatsapp-number-id, acts only on that number’s links; an account-wide credential without the header sees the whole workspace.
PUT
/
v1
/
lead-pages
/
{pageLinkId}
/
forms
/
{formId}
Configure an Instant Form
curl --request PUT \
--url https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": true,
"templateId": null,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": {
"nome": {
"source": "field",
"key": "full_name"
}
},
"formName": "Orçamento — Outubro"
}
'import requests
url = "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}"
payload = {
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": True,
"templateId": None,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": { "nome": {
"source": "field",
"key": "full_name"
} },
"formName": "Orçamento — Outubro"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
consentDisclaimerKey: 'whatsapp_optin',
autoSendEnabled: true,
templateId: null,
freeText: 'Olá {{nome}}, recebemos seu pedido de orçamento!',
variableMap: {nome: {source: 'field', key: 'full_name'}},
formName: 'Orçamento — Outubro'
})
};
fetch('https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'consentDisclaimerKey' => 'whatsapp_optin',
'autoSendEnabled' => true,
'templateId' => null,
'freeText' => 'Olá {{nome}}, recebemos seu pedido de orçamento!',
'variableMap' => [
'nome' => [
'source' => 'field',
'key' => 'full_name'
]
],
'formName' => 'Orçamento — Outubro'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}"
payload := strings.NewReader("{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": true,
"templateId": null,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": {
"nome": {
"source": "field",
"key": "full_name"
}
},
"updatedAt": "2026-10-21T09:30:00.000Z"
}
}{
"error": "Every variable in the text needs a value. | Todas as variáveis do texto precisam de um valor.",
"code": "VARIABLES_UNMAPPED",
"missingVariables": [
"cidade"
]
}{
"error": "Unauthorized"
}{
"error": "This credential is not granted access to that WhatsApp number | Esta credencial não tem acesso a esse número de WhatsApp",
"code": "NUMBER_NOT_IN_GRANT"
}{
"error": "Page link not found | Vínculo de página não encontrado",
"code": "NOT_FOUND"
}{
"error": "Internal server error | Erro interno do servidor",
"code": "INTERNAL_ERROR"
}Authorizations
apiKeyapiKeyId
Your ps_ API key
Headers
Narrows an account-wide credential to one number (its id or instance id from GET /v1/numbers). Without it, an account-wide credential sees the whole workspace; a number-scoped key always sees only its own number.
Path Parameters
The link id (linked[].pageLinkId from GET /v1/lead-pages), not the Facebook Page id.
Numeric Instant Form id (forms[].formId).
Body
application/json
key of the consent checkbox (consentCheckboxes[].key). Required for auto-send.
Example:
"whatsapp_optin"
Message every new lead of the form automatically.
Example:
true
Official numbers: an APPROVED template of the number (templates[].id). Must be null on unofficial numbers.
Example:
null
Unofficial numbers: the message, with {{name}} placeholders. Must be null on official numbers.
Maximum string length:
4096Example:
"Olá {{nome}}, recebemos seu pedido de orçamento!"
Value of each template variable or placeholder: { "source": "field", "key": "<question key>" } or { "source": "static", "value": "..." }. Defaults to {}.
Show child attributes
Show child attributes
Example:
{
"nome": { "source": "field", "key": "full_name" }
}
Optional display label for the form.
Maximum string length:
255Example:
"Orçamento — Outubro"
Response
Configuration saved
Was this page helpful?
⌘I
Configure an Instant Form
curl --request PUT \
--url https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": true,
"templateId": null,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": {
"nome": {
"source": "field",
"key": "full_name"
}
},
"formName": "Orçamento — Outubro"
}
'import requests
url = "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}"
payload = {
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": True,
"templateId": None,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": { "nome": {
"source": "field",
"key": "full_name"
} },
"formName": "Orçamento — Outubro"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
consentDisclaimerKey: 'whatsapp_optin',
autoSendEnabled: true,
templateId: null,
freeText: 'Olá {{nome}}, recebemos seu pedido de orçamento!',
variableMap: {nome: {source: 'field', key: 'full_name'}},
formName: 'Orçamento — Outubro'
})
};
fetch('https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'consentDisclaimerKey' => 'whatsapp_optin',
'autoSendEnabled' => true,
'templateId' => null,
'freeText' => 'Olá {{nome}}, recebemos seu pedido de orçamento!',
'variableMap' => [
'nome' => [
'source' => 'field',
'key' => 'full_name'
]
],
'formName' => 'Orçamento — Outubro'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}"
payload := strings.NewReader("{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/lead-pages/{pageLinkId}/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consentDisclaimerKey\": \"whatsapp_optin\",\n \"autoSendEnabled\": true,\n \"templateId\": null,\n \"freeText\": \"Olá {{nome}}, recebemos seu pedido de orçamento!\",\n \"variableMap\": {\n \"nome\": {\n \"source\": \"field\",\n \"key\": \"full_name\"\n }\n },\n \"formName\": \"Orçamento — Outubro\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"consentDisclaimerKey": "whatsapp_optin",
"autoSendEnabled": true,
"templateId": null,
"freeText": "Olá {{nome}}, recebemos seu pedido de orçamento!",
"variableMap": {
"nome": {
"source": "field",
"key": "full_name"
}
},
"updatedAt": "2026-10-21T09:30:00.000Z"
}
}{
"error": "Every variable in the text needs a value. | Todas as variáveis do texto precisam de um valor.",
"code": "VARIABLES_UNMAPPED",
"missingVariables": [
"cidade"
]
}{
"error": "Unauthorized"
}{
"error": "This credential is not granted access to that WhatsApp number | Esta credencial não tem acesso a esse número de WhatsApp",
"code": "NUMBER_NOT_IN_GRANT"
}{
"error": "Page link not found | Vínculo de página não encontrado",
"code": "NOT_FOUND"
}{
"error": "Internal server error | Erro interno do servidor",
"code": "INTERNAL_ERROR"
}