Create Lookalike Audience

This endpoint allows you to create a Lookalike Audience based on an existing custom audience. A Lookalike Audience helps you reach new people who are similar to your existing customers, improving the chances of ad engagement and conversion.

POST /meta/create_lookalike_audience

Create Lookalike Audience

cURL

curl --request POST \
  --url https://public.plai.io/meta/create_lookalike_audience \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "sourceType": "<string>",
  "sourceId": "<string>",
  "audienceName": "<string>",
  "countryCode": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "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.

sourceType · string · required

Source Type = PAGE or AUDIENCE

sourceId · string

You can get the source id from get custom audiences endpoint. Pass custom audience id in sourceId parameter.

If sourceType is PAGE, you don’t need to send the sourceId parameter.
If sourceType is AUDIENCE, you must include the sourceId parameter.

audienceName · string · required

Audience Name

countryCode · string · required

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

Response

success · boolean

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

results · object

Show Results Object

id · string

Unique identifier for lookalike audience

name · string

Name of audience

error · string

Error string if something went wrong