Skip to main content
POST
https://public.plai.io
/
gads
/
create_lead_form
Create Lead Form
curl --request POST \
  --url https://public.plai.io/gads/create_lead_form \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "name": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "privacy_policy_url": "<string>",
  "call_to_action_type": "<string>",
  "call_to_action_description": "<string>",
  "input_fields": [
    "<string>"
  ]
}
'
{
  "success": true,
  "results": {
    "success": true,
    "leadFormAssetId": "<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.
​
name
string
required
The name of your business or brand, shown at the top of the lead form.Example: "Fresh Bites Cafe"
Maximum length: 25 characters.
​
headline
string
required
A short, attention-grabbing headline that appears above the form fields.Example: "Get Your Free Quote"
Maximum length: 30 characters.
​
description
string
required
A brief description providing context for why users should fill out the form.Example: "Schedule a consultation in under 2 minutes"
Maximum length: 90 characters
​
privacy_policy_url
url
required
A valid URL linking to your business’s privacy policy.
Required to comply with data privacy regulations.Example: "https://yourdomain.com/privacy"
Required for compliance with data privacy regulations.
​
call_to_action_type
string
required
Type of call-to-action button that appears below the form.Choose one from the following supported values: LEARN_MORE, GET_QUOTE,APPLY_NOW, SIGN_UP, CONTACT_US, SUBSCRIBE, DOWNLOAD, BOOK_NOW, GET_OFFER, REGISTER, GET_INFO, REQUEST_DEMO, JOIN_NOW, GET_STARTED
​
call_to_action_description
string
required
A short message shown with the call-to-action button.Use this to reinforce value or next steps.Example: "We'll contact you within 24 hours with your custom quote."
Maximum length: 200 characters
​
input_fields
string[]
required
Fields to request from the user in the lead form.Each string should be one of the predefined input types supported by Google.
You may include multiple fields in the array.Supported Input fields: FULL_NAME, EMAIL, PHONE_NUMBER, POSTAL_CODE, STREET_ADDRESS, CITY, REGION, COUNTRY, WORK_EMAIL, COMPANY_NAME, WORK_PHONE, JOB_TITLE, FIRST_NAME, LAST_NAME, COMPANY_SIZE, ANNUAL_SALES, YEARS_IN_BUSINESS, JOB_DEPARTMENT, JOB_ROLE, CATEGORY, PREFERRED_CONTACT_METHOD, PREFERRED_LOCATION, PREFERRED_CONTACT_TIME, PURCHASE_TIMELINE, YEARS_OF_EXPERIENCE, JOB_INDUSTRY, LEVEL_OF_EDUCATION, PROPERTY_TYPE, REALTOR_HELP_GOAL, PROPERTY_COMMUNITY, PRICE_RANGE, NUMBER_OF_BEDROOMS, FURNISHED_PROPERTY, PETS_ALLOWED_PROPERTY, NEXT_PLANNED_PURCHASE, EVENT_SIGNUP_INTEREST, PREFERRED_SHOPPING_PLACES, FAVORITE_BRAND, TRANSPORTATION_COMMERCIAL_LICENSE_TYPE, EVENT_BOOKING_INTEREST, DESTINATION_COUNTRY, DESTINATION_CITY, DEPARTURE_COUNTRY, DEPARTURE_CITY, DEPARTURE_DATE, RETURN_DATE, NUMBER_OF_TRAVELERS, TRAVEL_BUDGET, TRAVEL_ACCOMMODATION

​
Response

​
success
boolean
Indicates that the HTTP response was successful (status code 200 OK).
​
results
object