Upload Account Custom Opt Out

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

For a successful integration, please refer to the API guide, which provides detailed information on the rules and limitations applicable to this endpoint.

File Format

The uploaded CSV file should adhere to the following format:

  • Plain Text Encoding: Ensure the file is encoded in plain text (e.g., UTF-8).

  • One Entry Per Row: Each email address or MD5 hash should be on a new line.

  • Optional Header Row: The first row of the file can be a header row with column names, which will be skipped during processing.

  • Supported Content: Each row should contain either a valid email address or a 32-character lowercase hexadecimal MD5 hash.

    Example (Emails):

    Example (MD5 Hashes):

    md5
    e10adc3949ba59abbe56e057f20f883e
    d41d8cd98f00b204e9800998ecf8427e
    a5d4c3b7d6e0b2a1f83d7e9c5f0d9a2b
❗️

For consistent identification, ensure email addresses are converted to lowercase before generating their MD5 hash.

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.

boolean
Defaults to false

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

Headers
string
Defaults to YOUR_API_ID

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain