Upload Account Custom Opt Out

post

https://api.retention.com/api/v1/custom_optouts

This API allows you to upload a file containing email addresses or their MD5 hashes of individuals who you do not wish to be resolved by Retention.com. This is crucial for complying with "do not sell" requests and ensuring data privacy for your customers. You can make up to 5 requests per day, with each request handling 40,000 emails a day.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

file

Defaults to YOUR_FILE.csv

The CSV file to be uploaded. Each row in the file should contain either a single email address or its MD5 hash. The file should be plain text encoded (e.g., UTF-8). The first row can optionally be a header row, which will be ignored. See the File Format section below for details.

is_md5

boolean

Defaults to false

If your file contains only MD5 hashed of the emails, set this to true, else it can be ignored.

Headers

Content-Type

string

Defaults to multipart/form-data

Specifies that the request body contains form data, including a file upload.

api-id

string

Defaults to YOUR_API_ID

Your account's API ID. Replace YOUR_API_ID with your actual API ID.

api-key

string

Defaults to YOUR_API_KEY

Your API key (if required as a separate header). Replace YOUR_API_KEY with your actual API key

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

400400

401401