---
title: "Create a lead form — estimate"
method: POST
path: "/v1/messaging/ads/lead-forms/estimate"
tags: ["Lead Gen"]
---

# Create a lead form — estimate

`POST /v1/messaging/ads/lead-forms/estimate`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/ads/lead-forms/estimate`
- Auth: HTTP bearer

Price the request without executing it. Same body as `POST /v1/messaging/ads/lead-forms`.

## Request body

- object
  - `name` string, required
  - `locale` string: Deprecated: use platformSpecificData.locale.
  - `accountId` string, required
  - `questions` object[]: Deprecated (Meta legacy shape): use platformSpecificData.questions.
    - `key` string: CUSTOM questions only.
    - `type` string, required: EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
    - `label` string: CUSTOM questions only.
    - `options` object[]
      - `key` string
      - `value` string
    - `inline_context` string
  - `thankYouBody` string: Deprecated: use platformSpecificData.thankYouBody.
  - `thankYouTitle` string: Deprecated: use platformSpecificData.thankYouTitle.
  - `privacyPolicyUrl` string, uri, required
  - `followUpActionUrl` string, uri: Deprecated: use platformSpecificData.followUpActionUrl.
  - `thankYouButtonText` string: Deprecated: use platformSpecificData.thankYouButtonText.
  - `thankYouButtonType` string: Deprecated: use platformSpecificData.thankYouButtonType.
  - `thankYouWebsiteUrl` string, uri: Deprecated: use platformSpecificData.thankYouWebsiteUrl.
  - `platformSpecificData` union: Form content; the shape is selected by the accountId's platform. Unknown fields are a 400 (strict-parsed).
    - object
      - `locale` string
      - `questions` object[], required
        - `key` string: CUSTOM questions only.
        - `type` string, required: EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
        - `label` string: CUSTOM questions only.
        - `options` object[]
          - `key` string
          - `value` string
        - `inline_context` string
      - `contextCard` object
        - `style` 'LIST_STYLE' | 'PARAGRAPH_STYLE'
        - `title` string
        - `content` string[]
        - `buttonText` string
        - `coverPhoto` string, uri: Direct public JPEG or PNG image URL, up to 5 MB. Uploaded as an unpublished Page photo and attached to the form. Redirects, Ad Image hashes and IDs are not supported.
      - `thankYouBody` string
      - `thankYouTitle` string
      - `followUpActionUrl` string, uri
      - `thankYouButtonText` string
      - `thankYouButtonType` string
      - `thankYouWebsiteUrl` string, uri
      - `isOptimizedForQuality` boolean: Set true for a higher-intent form (adds a review step before submit).
      - `privacyPolicyLinkText` string
      - `isPhoneSmsVerifyEnabled` boolean: Requires the lead to verify their phone number over SMS before the form submits (Meta is_phone_sms_verify_enabled). Only meaningful on a form with a PHONE question. Meta can restrict this parameter to apps holding a capability: when it does, the create fails with a 422 naming platformSpecificData.isPhoneSmsVerifyEnabled, and the toggle then has to be set in Meta's form builder.
      - `thankYouEnableMessenger` boolean: Adds a 'Continue in Messenger' option to the thank-you page (Meta thank_you_page.enable_messenger), so the lead can carry on chatting with the Page. Set thankYouButtonType to MESSAGE_BUSINESS or P2B_MESSENGER to make the chat the primary button.
      - `questionPageCustomHeadline` string
      - `blockDisplayForNonTargetedViewer` boolean
    - object
      - `state` 'DRAFT' | 'PUBLISHED': Defaults to DRAFT.
      - `locale` object
        - `country` string
        - `language` string
      - `consents` object[]
        - `required` boolean: Whether the viewer must tick this consent to submit. Defaults to false.
        - `description` string, required
      - `headline` string, required
      - `questions` union[], required
        - union
          - object
            - `kind` 'text', required
            - `name` string, required
            - `question` string, required
            - `required` boolean
            - `responseEditable` boolean
            - `maxResponseLength` integer: Defaults to 300 on LinkedIn's side.
          - object
            - `kind` 'multipleChoice', required
            - `name` string, required
            - `choices` object[], required
              - …
            - `question` string, required
            - `required` boolean
            - `responseEditable` boolean
      - `adAccountId` string, required: LinkedIn ad account id (resolves the owning organization).
      - `description` string, required
  - `isOptimizedForQuality` boolean: Deprecated: use platformSpecificData.isOptimizedForQuality.
  - `privacyPolicyLinkText` string: Deprecated: use platformSpecificData.privacyPolicyLinkText.

## Response `200`

Estimate

- Estimate
  - `operation` string
  - `estimated_credits` number
  - `credits_to_reserve` number
  - `estimated_usage` object
  - `note` string, nullable
  - `balance` object
    - `available` number
  - `sufficient` boolean

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)