Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Create a new lead gen form on a Facebook page
POST https://services.leadconnectorhq.com/ad-publishing/facebook/page/{pageId}/forms
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion.
Version
string
default:"2021-07-28"
required
Version de la API.
Path parameters
pageId
string
default:"103456789012345"
required
Facebook page identifier
Body
type
string
default:"MORE_VOLUME"
required
Lead form type Posibles valores: ‘MORE_VOLUME’, ‘HIGHER_INTENT’
name
string
default:"Contact Form"
required
Lead form name
locationId
string
default:"loc_abc123"
required
Account identifier
List of questions displayed on the lead form
label
string
default:"What is your name?"
Question label text shown to the user
key
string
default:"name"
required
Question key
type
string
default:"SHORT_ANSWER"
required
Question input type — use a prefilled type for standard fields or CUSTOM / SHORT_ANSWER for freeform questions Posibles valores: ‘CUSTOM’, ‘CITY’, ‘COMPANY_NAME’, ‘COUNTRY’, ‘DATE_OF_BIRTH’, ‘EMAIL’, ‘FIRST_NAME’, ‘FULL_NAME’, ‘GENDER’, ‘JOB_TITLE’, ‘LAST_NAME’, ‘MARITAL_STATUS’, ‘MILITARY_STATUS’, ‘PHONE’, ‘POST_CODE’, ‘RELATIONSHIP_STATUS’, ‘STATE’, ‘STREET_ADDRESS’, ‘WORK_EMAIL’, ‘WORK_PHONE_NUMBER’, ‘ZIP’, ‘SHORT_ANSWER’
Answer options for multiple-choice questions (only applies to CUSTOM type)
key
string
default:"option 1"
required
Option key
value
string
default:"Option 1"
required
Option value
questionPageHeadline
string
default:"Tell us about yourself"
Question page headline
privacyPolicyLink
string
default:"https://example.com/privacy"
required
Privacy policy URL
privacyPolicyText
string
default:"We respect your privacy"
Privacy policy text
Respuestas
422 - Unprocessable Entity
Ejemplo
curl -X POST 'https://services.leadconnectorhq.com/ad-publishing/facebook/page/YOUR_pageId/forms' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"type": "MORE_VOLUME",
"name": "Contact Form",
"locationId": "loc_abc123",
"questions": [
{
"key": "full_name",
"type": "FULL_NAME",
"options": []
},
{
"key": "email_address",
"type": "EMAIL",
"options": []
},
{
"key": "are_you_interested",
"label": "Are you interested?",
"type": "CUSTOM",
"options": [
{
"value": "Yes"
},
{
"value": "No"
}
]
}
],
"questionPageHeadline": "Tell us about yourself",
"privacyPolicyLink": "https://example.com/privacy",
"privacyPolicyText": "We respect your privacy"
}'