Create a lead form
Creates a lead form on a Facebook Page or LinkedIn Company Page to collect contact details from ads.
The form content goes inside platformSpecificData for both platforms (the shape is selected by the accountId's platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms), where accountId may be the metaads ads connection (its Page comes from the Facebook account linked to the same profile), an Instagram account (the Page its ads run under: its own linked Page, else the Facebook or business-login Meta ads account on the same profile) or the Facebook account itself; the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent; mixing both shapes is a 400. LinkedIn: created on the ad account's Company Page. NOT idempotent: a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on.
Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min
Request
- Base URL: https://apihub.co.il
- URL: https://apihub.co.il/v1/messaging/ads/lead-forms
- Auth: HTTP bearer
Headers
Replay-safe: the same execution is returned instead of charging twice
Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…
Request body
Response
Completed
Changes
No recorded changes to this operation across all 2 revisions of this API.