Audience

In addition to the Do Not Mail audience, you can create additional audiences for suppression or mailing. This is done by uploading a CSV in the Audiences section or by calling the API.

This endpoint is only able to add members to an existing list in your Poplar account. You must first create an Audience within the Poplar platform to generate an audience_id

Create Audience Member

POST https://api.heypoplar.com/v1/audience/:id

Use this endpoint to programmatically add users to an audience. At least one of the following is required: address, email, email_sha256 and identifier.

Path Parameters

Headers

Request Body

{
    // Response
}

Fetch Audiences

GET https://api.heypoplar.com/v1/audiences

This endpoint returns a list of audiences attached to your organization.

Headers

[
    {
        "id": "2965b4fc-30cc-4ec6-b90a-d460fd25f90d",
        "name": "Do Not Mail List",
        "description": "Do Not Mail List for Share Local Media",
        "member_count": 1337
    },
    {
        "id": "087d0603-5b97-4656-9a2b-f739d44fe11b",
        "name": "Existing Customers",
        "description": "Customers who have made a purchase.",
        "member_count": 25181
    },
]

Upload Audience CSV

If you are uploading a CSV of audience members, you can use this template:

Manually Add a Single Audience Member

When you are viewing the audience, you can also add a single audience member:

Common Questions

Should I upload a CSV to Audiences or use the Audience API?

  • If you have a list (or batch) of addresses you want to load into Poplar, we recommend using the CSV upload.

  • If you need to keep your Audience synced in real-time with your external marketing platform, we recommend setting up the API call.

Last updated