Versão Graph API

Page Leadgen Forms

Leitura

Não é possível executar esta operação neste ponto de extremidade.

Criando

You can make a POST request to leadgen_forms edge from the following paths:

/{page_id}/leadgen_forms

When posting to this edge, a Page will be created.

Additional Errors

In addition to the errors listed below, you may receive unknown errors for privacy_policy if the URL is invalid or the link_text exceeds 70 characters.

Permissions

If you upload an image by specifying cover_photo parameter, the access_token accompanying the request must include the pages_manage_posts permission.

Parâmetros

Parâmetro	Descrição
`allow_organic_lead_retrieval` boolean	Valor padrão: `true` Previously, this flag controlled whether any leads submitted in a non-Ad context were retrievable. Now this flag will not be considered and it will be deprecated entirely. To control visibility of Lead Forms in a non-Ad context you should use 'block_display_for_non_targeted_viewer'
`block_display_for_non_targeted_viewer` boolean	Whether to make the organic post invisible to viewers in non-Ad context
`context_card` Object	Optional context card shown as the intro page Supports Emoji
`title` string
`style` enum {LIST_STYLE, PARAGRAPH_STYLE}
`content` array<string>
`button_text` string
`cover_photo_id` photo ID
`cover_photo` file	Custom cover photo for context card
`custom_disclaimer` Object	Customized disclaimer including title, body content with inline links, and consent checkboxes
`title` string
`body` Object
`text` string	Obrigatório
`url_entities` list<JSON object>
`checkboxes` list<Object>
`is_required` boolean	Valor padrão: `true`
`is_checked_by_default` boolean	Valor padrão: `false`
`text` string	Obrigatório
`key` string
`follow_up_action_url` URI	The final destination URL that user will go to when clicking view website button
`is_for_canvas` boolean	Valor padrão: `false` Flag to indicate that the form is going to be used under a canvas
`is_optimized_for_quality` boolean	Valor padrão: `false` Flag to indicate whether the form will be optimized for quality
`locale` enum {AR_AR, CS_CZ, DA_DK, DE_DE, EL_GR, EN_GB, EN_US, ES_ES, ES_LA, FI_FI, FR_FR, HE_IL, HI_IN, HU_HU, ID_ID, IT_IT, JA_JP, KO_KR, NB_NO, NL_NL, PL_PL, PT_BR, PT_PT, RO_RO, RU_RU, SV_SE, TH_TH, TR_TR, VI_VN, ZH_CN, ZH_HK, ZH_TW}	The locale of the form. Pre-defined questions renders in this locale
`name` string	The name that will help identity the form Obrigatório
`privacy_policy` Object	The url and link_text of the privacy policy of advertiser. link_text is limited to a maximum of 70 characters.
`url` string
`link_text` string
`question_page_custom_headline` string	The custom headline for the question page within the form
`questions` list<Object>	An array of questions of the form Obrigatório
`key` string
`label` string
`type` enum {CUSTOM, CITY, COMPANY_NAME, COUNTRY, DOB, EMAIL, GENDER, FIRST_NAME, FULL_NAME, JOB_TITLE, LAST_NAME, MARITIAL_STATUS, PHONE, PHONE_OTP, POST_CODE, PROVINCE, RELATIONSHIP_STATUS, STATE, STREET_ADDRESS, ZIP, WORK_EMAIL, MILITARY_STATUS, WORK_PHONE_NUMBER, SLIDER, STORE_LOOKUP, STORE_LOOKUP_WITH_TYPEAHEAD, DATE_TIME, ID_CPF, ID_AR_DNI, ID_CL_RUT, ID_CO_CC, ID_EC_CI, ID_PE_DNI, ID_MX_RFC, JOIN_CODE, USER_PROVIDED_PHONE_NUMBER, FACEBOOK_LEAD_ID, EMAIL_ALIAS, MESSENGER}	Obrigatório
`inline_context` string
`options` list<JSON object>
`dependent_conditional_questions` list<JSON object>
`conditional_questions_group_id` LeadGen Conditional Questions Group ID
`thank_you_page` Object	Optional customized thank you page displayed post submission
`title` string	Obrigatório
`body` string
`short_message` string
`button_text` string
`button_description` string
`business_phone_number` phone number string
`enable_messenger` boolean	Valor padrão: `false`
`website_url` string
`button_type` enum {VIEW_WEBSITE, CALL_BUSINESS, MESSAGE_BUSINESS, DOWNLOAD, SCHEDULE_APPOINTMENT, VIEW_ON_FACEBOOK, PROMO_CODE, NONE}	Obrigatório
`country_code` string
`tracking_parameters` JSON object {string : string}	Map for additional tracking parameters to include with the form's field data

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

}

Error Codes

Erro	Descrição
100	Invalid parameter
192	Invalid phone number
368	The action attempted has been deemed abusive or is otherwise disallowed

Atualizando

Não é possível executar esta operação neste ponto de extremidade.

Excluindo

Não é possível executar esta operação neste ponto de extremidade.