Audience
Last updated
Was this helpful?
Last updated
Was this helpful?
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 section or by calling the API.
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
.
id*
string
This is the ID of the audience you are adding to. You can obtain this from the audience page on the dashboard, or from the Fetch Audiences endpoint.
Authorization*
string
Bearer ProductionAccessToken
address
object
Postal Address object (see below).
identifier
string
A unique identifier for this user. This may be a Customer ID, database ID or other field.
email_sha256
string
A SHA256 hash of the users email address. Please ensure that the email address is lowercased prior to computing the hash.
string
Email Address
address_1*
string
First line of the street address (e.g., house number and street name).
address_2
string
Second line of the street address (e.g., apartment or suite number). Optional in all combinations.
city
string
City name.
state
string
State abbreviation (e.g., "CA" for California
postal_code*
string
ZIP Code.
name
string
Name of the addressee.
GET
https://api.heypoplar.com/v1/audiences
This endpoint returns a list of audiences attached to your organization.
Authorization*
string
Bearer ProductionAccessToken
If you are uploading a CSV of audience members, you can use this template:
When you are viewing the audience, you can also add a single audience member:
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.