Inbox Placement Blacklist & SpamAssassin Report

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server
https://api.instantly.ai/
Mock server
https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement report entry

Example: "01959271-1bad-7dc6-8430-302cc3e0498f"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-03-14T02:17:21.069Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-03-14"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1bad-7dc6-8430-302d28d99ec7"
test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "01959271-1bad-7dc6-8430-302ea8f884c1"
domainstringread-onlyrequired

Domain of the inbox placement report

Example: "growinstantly.com"
domain_ipstringread-onlyrequired

IP address of the domain

Example: "192.168.1.1"
spam_assassin_scorenumberread-onlyrequired

SpamAssassin score for the email, indicating spam likelihood

Example: 2.5
domain_blacklist_countnumberread-only

Count of blacklists the domain is listed on

Example: 5
domain_ip_blacklist_countnumberread-only

Count of blacklists the domain IP is listed on

Example: 3
spam_assassin_reportobjectread-only

Detailed SpamAssassin analysis report

blacklist_reportobjectread-only

Detailed blacklist report for the domain or IP

{
  "id": "01959271-1bad-7dc6-8430-302cc3e0498f",
  "timestamp_created": "2025-03-14T02:17:21.069Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1bad-7dc6-8430-302d28d99ec7",
  "test_id": "01959271-1bad-7dc6-8430-302ea8f884c1",
  "domain_blacklist_count": 5,
  "domain": "growinstantly.com",
  "domain_ip": "192.168.1.1",
  "domain_ip_blacklist_count": 3,
  "spam_assassin_score": 2.5,
  "spam_assassin_report": {
    "is_spam": false,
    "report": [ … ],
    "spam_score": 0
  },
  "blacklist_report": {
    "address": "growinstantly.com",
    "blacklisted_count": 5,
    "details": [],
    "ip": "104.21.62.47",
    "is_blacklisted": true,
    "is_domain": true
  }
}

List inbox placement blacklist & spamassassin report

Request

Requires one of the following scopes: inbox_placement_reports:read, inbox_placement_reports:all, all:read, all:all

Query
test_idstring(uuid)required
Example: test_id=d290f1ee-6c54-4b01-90e6-d701748f0851
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring(uuid)

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084
date_fromstring
Example: date_from=2025-03-14T02:17:23.701Z
date_tostring
Example: date_to=2025-03-14T02:17:23.701Z
skip_spam_assassin_reportboolean

Flag to skip including spam_assassin_report JSON

Example: skip_spam_assassin_report=false
skip_blacklist_reportboolean

Flag to skip including blacklist_report JSON

Example: skip_blacklist_report=false
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-reports?date_from=2025-03-14T02%3A17%3A23.701Z&date_to=2025-03-14T02%3A17%3A23.701Z&limit=10&skip_blacklist_report=false&skip_spam_assassin_report=false&starting_after=01956fbd-0eb1-72db-a565-82977a586084&test_id=d290f1ee-6c54-4b01-90e6-d701748f0851' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Inbox Placement Blacklist & SpamAssassin Report

Bodyapplication/json
itemsArray of objects(Inbox Placement Blacklist & SpamAssassin Report)required
items[].​idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement report entry

Example: "01959271-1bad-7dc6-8430-302cc3e0498f"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-03-14T02:17:21.069Z"
items[].​timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-03-14"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1bad-7dc6-8430-302d28d99ec7"
items[].​test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "01959271-1bad-7dc6-8430-302ea8f884c1"
items[].​domainstringread-onlyrequired

Domain of the inbox placement report

Example: "growinstantly.com"
items[].​domain_ipstringread-onlyrequired

IP address of the domain

Example: "192.168.1.1"
items[].​spam_assassin_scorenumberread-onlyrequired

SpamAssassin score for the email, indicating spam likelihood

Example: 2.5
items[].​domain_blacklist_countnumberread-only

Count of blacklists the domain is listed on

Example: 5
items[].​domain_ip_blacklist_countnumberread-only

Count of blacklists the domain IP is listed on

Example: 3
items[].​spam_assassin_reportobjectread-only

Detailed SpamAssassin analysis report

items[].​blacklist_reportobjectread-only

Detailed blacklist report for the domain or IP

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Get inbox placement blacklist & spamassassin report

Request

Requires one of the following scopes: inbox_placement_reports:read, inbox_placement_reports:all, all:read, all:all

Path
idstringrequired
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-reports/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Inbox Placement Blacklist & SpamAssassin Report

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement report entry

Example: "01959271-1bad-7dc6-8430-302cc3e0498f"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-03-14T02:17:21.069Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-03-14"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1bad-7dc6-8430-302d28d99ec7"
test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "01959271-1bad-7dc6-8430-302ea8f884c1"
domainstringread-onlyrequired

Domain of the inbox placement report

Example: "growinstantly.com"
domain_ipstringread-onlyrequired

IP address of the domain

Example: "192.168.1.1"
spam_assassin_scorenumberread-onlyrequired

SpamAssassin score for the email, indicating spam likelihood

Example: 2.5
domain_blacklist_countnumberread-only

Count of blacklists the domain is listed on

Example: 5
domain_ip_blacklist_countnumberread-only

Count of blacklists the domain IP is listed on

Example: 3
spam_assassin_reportobjectread-only

Detailed SpamAssassin analysis report

blacklist_reportobjectread-only

Detailed blacklist report for the domain or IP

Response
application/json
{
  "id": "01959271-1bad-7dc6-8430-302cc3e0498f",
  "timestamp_created": "2025-03-14T02:17:21.069Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1bad-7dc6-8430-302d28d99ec7",
  "test_id": "01959271-1bad-7dc6-8430-302ea8f884c1",
  "domain_blacklist_count": 5,
  "domain": "growinstantly.com",
  "domain_ip": "192.168.1.1",
  "domain_ip_blacklist_count": 3,
  "spam_assassin_score": 2.5,
  "spam_assassin_report": {
    "is_spam": false,
    "report": [ … ],
    "spam_score": 0
  },
  "blacklist_report": {
    "address": "growinstantly.com",
    "blacklisted_count": 5,
    "details": [],
    "ip": "104.21.62.47",
    "is_blacklisted": true,
    "is_domain": true
  }
}

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing items

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Schemas