Create Inbox Test

curl --request POST \
  --url https://api.campaigncleaner.com/v1/create_inbox_test \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_name": "My Campaign Inbox Test"
}
'

{
  "job_id": "12345",
  "test_name": "My Campaign Inbox Test",
  "mailtester_address": "mailtest+a1b2c3d4@campaigncleaner.com",
  "instructions": "Send your campaign to ALL addresses in the send_to list. Results will be available via get_inbox_test_results once processing is complete.",
  "send_to": [
    "seed1@gmail.com",
    "seed2@yahoo.com",
    "seed3@outlook.com",
    "mailtest+a1b2c3d4@campaigncleaner.com"
  ]
}

API Endpoints

Create Inbox Test

The create_inbox_test API allows you to create a new inbox placement test. Once created, you will receive a list of seed email addresses to send your campaign to. After sending your campaign to all addresses in the send_to list, you can use the get_inbox_test_results API to retrieve the placement results.

This endpoint requires an active Campaign Cleaner subscription or a standalone Inbox Placement Tester subscription. One API credit will be deducted per test created.

Header:

X-CC-API-Key: Your API Key

Request Body:

Required:

test_name: The name of your inbox test - maximum 255 characters.

Response:

job_id: The unique ID of the inbox test, used to retrieve results via the get_inbox_test_results API.
test_name: The name you provided for the test.
mailtester_address: The unique monitoring address that must be included in your send list. This is already included in the send_to array.
instructions: A description of what to do next.
send_to: An array of all seed email addresses including the mailtester_address. Send your campaign to every address in this list.

In the event of an error, you will get an “error:” response with a description of the reason.

POST

create_inbox_test

Create Inbox Test

curl --request POST \
  --url https://api.campaigncleaner.com/v1/create_inbox_test \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_name": "My Campaign Inbox Test"
}
'

{
  "job_id": "12345",
  "test_name": "My Campaign Inbox Test",
  "mailtester_address": "mailtest+a1b2c3d4@campaigncleaner.com",
  "instructions": "Send your campaign to ALL addresses in the send_to list. Results will be available via get_inbox_test_results once processing is complete.",
  "send_to": [
    "seed1@gmail.com",
    "seed2@yahoo.com",
    "seed3@outlook.com",
    "mailtest+a1b2c3d4@campaigncleaner.com"
  ]
}

Headers

X-CC-API-Key

string

Body

application/json

test_name

string

Response

200 - application/json

The response is of type object.

Send Campaign Get Inbox Test Results

API Reference

Headers

Body

Response