Create Contact List Audience

This endpoint allows you to create a custom audience by uploading a CSV file containing user data (such as emails, phone numbers, or other identifiers). The uploaded data is processed and matched against platform records to build a targeted audience for advertising purposes.

POST /meta/create_fb_csv_audience

Create Contact List Audience

cURL

curl --request POST \
  --url https://public.plai.io/meta/create_fb_csv_audience \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'userId=<string>' \
  --form 'audienceName=<string>' \
  --form 'mode=<string>' \
  --form 'audienceId=<string>' \
  --form csvFile='@example-file'

200

{
  "success": true,
  "results": {
    "success": true,
    "audienceId": "<string>",
    "audienceName": "<string>",
    "invalid_entry_samples": {},
    "num_invalid_entries": 123,
    "num_received": 123,
    "session_id": "<string>",
    "error": "<string>"
  }
}

Request Body

The request body for this endpoint should be sent as multipart/form-data. The following fields are expected:

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.

audienceName · string · required

The name of the audience you are creating. This name will be displayed in your Facebook Ads account.

csvFile · file · required

Download Sample CSV

Sample CSV

Make sure to follow csv guidelines from here

Audience Csv. Ensure the file is in CSV format.

mode · string · default: "create"

Operation mode for the audience : create (default): Create a new audience. append: Add more entries to an existing audience. replace: Replace all entries in an existing audience. remove: Remove entries from an existing audience Required when modifying an existing audience.

audienceId · string

The ID of the existing audience to modify. Required when mode is append, replace, or remove.

Response

success · boolean

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

results · object

Show Audience Results

success · boolean

Indicates whether the specific operation or API action was successful.

audienceId · string

Unique identifier for the audience

audienceName · string

Name of the audience

invalid_entry_samples · object

Empty object when no invalid entries exist

num_invalid_entries · number

Count of invalid entries in the audience

num_received · number

Total number of entries received

session_id · string

Processing session identifier

error · string

Error string if something went wrong