Do Not Mail

Managing your do not mail list is just as important for direct mail as it is for email. We offer two ways to suppress mailings, either via an API or manually via a .csv list upload. The API is the easiest way to integrate an opt out form with our triggered mail service.

You can also set up rules for audience suppression to suppress by geographic area, and repeat frequency.

Recipient suppression can be made via any of the following four data types:

• Email (plaintext or hashed)

• Address

• Customer ID (for known customers)

When you send an address we will run it through our CASS Standardization and base the opt out on the updated version as oppose to the original provided.

Do Not Mail

POST https://api.heypoplar.com/v1/do-not-mail

Either email, email_sha256, identifier, or address is required. For suppression to work, the same identifier must be sent when triggering a mailing.

Headers

Name	Type	Description
Authorization*	string	Bearer ProductionAccessToken

Request Body

Name	Type	Description
address*	object	Customer mailing address.
identifier	string	A unique identifier for the customer within your system. This could be a database ID or derivative, however it must be unique to the specific customer.
email_sha256	string	The SHA-256 hash of the customers lowercased email address, as a 64-character text string.
email*	string	Customer email email address.

201: Created Do Not Mail list member added

{
    // Response
}

400: Bad Request Incorrectly formatted or missing data

{
    // Response
}

Address Object

The address object is structured as follows:

Field	Type	Description
address_1	String	Required
address_2	String	Optional
city	String	Optional
state	String	Optional
postal_code	String	Required
country_code	String	Optional An ISO Alpha-2 formatted country code. By default we assume that this is US.