Lead Gen

Create a lead form

Changed on

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.

post/v1/ads/lead-forms

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/ads/lead-forms
  • Auth: HTTP bearer

Request body

accountIdstring required
namestring required
privacyPolicyUrlstring uri required
privacyPolicyLinkTextstring

Deprecated: use platformSpecificData.privacyPolicyLinkText.

followUpActionUrlstring uri

Deprecated: use platformSpecificData.followUpActionUrl.

localestring

Deprecated: use platformSpecificData.locale.

thankYouTitlestring

Deprecated: use platformSpecificData.thankYouTitle.

thankYouBodystring

Deprecated: use platformSpecificData.thankYouBody.

thankYouButtonTextstring

Deprecated: use platformSpecificData.thankYouButtonText.

thankYouButtonTypestring

Deprecated: use platformSpecificData.thankYouButtonType.

thankYouWebsiteUrlstring uri

Deprecated: use platformSpecificData.thankYouWebsiteUrl.

isOptimizedForQualityboolean

Deprecated: use platformSpecificData.isOptimizedForQuality.

Example request

{
  "locale": "EN_US",
  "thankYouButtonType": "VIEW_WEBSITE",
  "platformSpecificData": {
    "locale": "EN_US",
    "thankYouButtonType": "VIEW_WEBSITE",
    "customDisclaimer": {
      "title": "WhatsApp",
      "body": "Acme can contact you on WhatsApp about your request.",
      "checkboxes": [
        {
          "key": "whatsapp_optin",
          "text": "I agree to receive WhatsApp messages from Acme"
        }
      ]
    }
  }
}

Response

Created form.

statusstring

Example response

{
  "status": "success"
}

Changes

  • c083c0fa652bRevision changes
    • info

      added the new optional request property //

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status