Create Leadform

This endpoint is used to create a leadform.

POST /meta/create_leadform

Create Leadform

cURL

curl --request POST \
  --url https://public.plai.io/meta/create_leadform \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "leadFormQuestions": [
    {
      "type": "<string>",
      "label": "<string>",
      "options": [
        {
          "value": "<string>",
          "key": "<string>"
        }
      ]
    }
  ],
  "privacyPolicyUrl": "<string>",
  "privacyPolicyName": "<string>",
  "questionPageCustomHeadline": "<string>",
  "leadsFormName": "<string>",
  "thankYouPage": {
    "title": "<string>",
    "body": "<string>",
    "button_text": "<string>",
    "button_type": "<string>",
    "website_url": "<string>",
    "country_code": "<string>",
    "business_phone_number": "<string>"
  },
  "language": "<string>",
  "form_type": "<string>",
  "intro": {
    "title": "<string>",
    "style": "<string>",
    "content": [
      "<string>"
    ]
  }
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "leadFormId": "<string>",
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

leadFormQuestions · object[] · required

Show Lead Form Questions Array

type · string · required

Type of question CUSTOM, CITY, COMPANY_NAME, COUNTRY, DOB, EMAIL, GENDER, FIRST_NAME, FULL_NAME, JOB_TITLE, LAST_NAME, MARITIAL_STATUS, WHATSAPP_NUMBER, EDUCATION_LEVEL, WEBSITE, 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, VIN, LICENSE_PLATE

label · string

Custom label for CUSTOM type questions

options · object[]

Show Options Array

value · string · required

Display value of the option

key · string · required

Internal key for the option

privacyPolicyUrl · string · required

URL for the privacy policy

privacyPolicyName · string · required

Display name for the privacy policy link

questionPageCustomHeadline · string

Custom headline text for the question page

leadsFormName · string · required

Name for the leads form

thankYouPage · object · required

Show Thank You Page Object

title · string · required

Title displayed on thank you page

body · string · required

Body text displayed on thank you page

button_text · string · required

Text for the action button

button_type · string · required

Type of button: VIEW_WEBSITE, CALL_BUSINESS

website_url · string

URL for the website button

This field must be required when button_type is set to VISIT_WEBSITE.

country_code · string

ISO 3166-1 alpha-2 country codes e.g: US,UK

This field must be required when button_type is set to CALL_BUSINESS.

business_phone_number · string

Business phone number to display

This field must be required when button_type is set to CALL_BUSINESS.

language · string · required

Language code for the form: 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

form_type · string · required

Type of form: MORE_VOLUME or HIGHER_INTENT

intro · object

Show Intro Object

title · string · required

Title for the introduction section

style · string · required

Styles: LIST_STYLE, PARAGRAPH_STYLE

content · string[] · required

List items or content for the introduction section

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

leadFormId · string

Unique identifier for the lead form

error · string

Error string if something went wrong