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: "019a44a1-d116-7249-b994-c2f377a66bf1"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-11-02T12:54:06.870Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-11-02"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "019a44a1-d116-7249-b994-c2f4911249af"
test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "019a44a1-d116-7249-b994-c2f56e41797c"
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_countnull or numberread-only

Count of blacklists the domain is listed on

Example: 5
domain_ip_blacklist_countnull or numberread-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": "019a44a1-d116-7249-b994-c2f377a66bf1",
  "timestamp_created": "2025-11-02T12:54:06.870Z",
  "timestamp_created_date": "2025-11-02",
  "organization_id": "019a44a1-d116-7249-b994-c2f4911249af",
  "test_id": "019a44a1-d116-7249-b994-c2f56e41797c",
  "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

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-11-02T12:54:12.275Z
date_tostring
Example: date_to=2025-11-02T12:54:12.275Z
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-11-02T12%3A54%3A12.275Z&date_to=2025-11-02T12%3A54%3A12.275Z&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

The list of Inbox Placement Blacklist & SpamAssassin Report

items[].​idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement report entry

Example: "019a44a1-d116-7249-b994-c2f377a66bf1"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-11-02T12:54:06.870Z"
items[].​timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

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

Organization ID

Example: "019a44a1-d116-7249-b994-c2f4911249af"
items[].​test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "019a44a1-d116-7249-b994-c2f56e41797c"
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_countnull or numberread-only

Count of blacklists the domain is listed on

Example: 5
items[].​domain_ip_blacklist_countnull or numberread-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 timestamp, on an email depending on the specific API

Example: "019a44a1-e633-748e-8e1e-cc4d4afa6193"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "019a44a1-e633-748e-8e1e-cc4d4afa6193"
}

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
idstring(uuid)required

The ID of the requested item

Example: 019a44a1-e635-7577-9790-7507c82e4fb2
curl -i -X GET \
  https://api.instantly.ai/api/v2/inbox-placement-reports/019a44a1-e635-7577-9790-7507c82e4fb2 \
  -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: "019a44a1-d116-7249-b994-c2f377a66bf1"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

Example: "2025-11-02T12:54:06.870Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-11-02"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "019a44a1-d116-7249-b994-c2f4911249af"
test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "019a44a1-d116-7249-b994-c2f56e41797c"
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_countnull or numberread-only

Count of blacklists the domain is listed on

Example: 5
domain_ip_blacklist_countnull or numberread-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": "019a44a1-d116-7249-b994-c2f377a66bf1",
  "timestamp_created": "2025-11-02T12:54:06.870Z",
  "timestamp_created_date": "2025-11-02",
  "organization_id": "019a44a1-d116-7249-b994-c2f4911249af",
  "test_id": "019a44a1-d116-7249-b994-c2f56e41797c",
  "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 accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

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

SuperSearch Enrichment

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

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

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Webhook Event

A webhook event that was sent or attempted to be sent

Operations

DFY Email Account Order

A Done-For-You email account order

Operations

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

Email Template

A campaign email template

Schemas