Create Leadform Audience

This endpoint allows you to create a custom audience based on users who have interacted with your Facebook Lead Forms. It helps advertisers retarget users who have shown interest by submitting a lead form or engaging with lead ads.

POST /meta/create_leadform_audience

Create Leadform Audience

cURL

curl --request POST \
  --url https://public.plai.io/meta/create_leadform_audience \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "leadFormIds": [
    "<string>"
  ]
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "audience": {
      "id": "<string>",
      "name": "<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

Audience Name

description · string · required

Audience description

type · string · required

Type = open or close or submit

leadFormIds · string[] · required

Lead Form Ids

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.

audience · object

Show Audience Object

id · string

Unique identifier for lookalike audience

name · string

Name of audience

error · string

Error string if something went wrong