create_lead_form
Create lead generation forms on Facebook Pages with custom questions, context cards, and thank-you pages. Collect leads from ads using the required pages_manage_ads permission.
Instructions
Create a new lead generation form on a Facebook Page. Requires pages_manage_ads permission.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Lead form name | |
| page_id | Yes | Facebook Page ID | |
| questions | Yes | JSON array of questions. Each: {key: string, type: 'CUSTOM'|'EMAIL'|'PHONE'|'FULL_NAME'|'CITY'|'STATE'|'COUNTRY'|'ZIP'|'JOB_TITLE'|'COMPANY_NAME', label?: string} | |
| context_card | No | JSON object for the form's intro card (the headline + body copy shown before the fields), e.g. {"style":"PARAGRAPH_STYLE","title":"...","content":["..."],"button_text":"..."} | |
| thank_you_page | No | JSON object: {title: string, body: string, button_text?: string, button_type?: 'VIEW_WEBSITE'|'DOWNLOAD', website_url?: string}. VIEW_WEBSITE requires website_url | |
| privacy_policy_url | Yes | URL to privacy policy | |
| follow_up_action_url | No | URL to redirect after submission. Also merged into thank_you_page.website_url when that page needs one and none is set | |
| privacy_policy_link_text | No | Custom display text for the privacy policy link | |
| block_display_for_non_targeted_viewer | No | Hide the form from viewers outside the ad's target audience |