Schemas
/
Inbox Placement Test

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

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

Lead List

A list used to store leads

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "01959271-1f75-702a-99d0-46734eb868ef"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "01959271-1f75-702a-99d0-4674354394db"
namestringrequired

Name of the lead list

Example: "My Lead List"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-03-14T02:17:22.037Z"
has_enrichment_taskboolean

Whether this list runs the enrichment process on every added lead or not

Example: false
owned_bystring(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "01959271-1f75-702a-99d0-46753cb39fa6"
{
  "id": "01959271-1f75-702a-99d0-46734eb868ef",
  "organization_id": "01959271-1f75-702a-99d0-4674354394db",
  "has_enrichment_task": false,
  "owned_by": "01959271-1f75-702a-99d0-46753cb39fa6",
  "name": "My Lead List",
  "timestamp_created": "2025-03-14T02:17:22.037Z"
}

Inbox Placement Test

An inbox placement test

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "01959271-1f73-794d-b682-93ffad1e5a45"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1f73-794d-b682-9400350ca566"
namestringrequired

Name of the inbox placement test

Example: "My Inbox Placement Test"
typenumberrequired

Whether the inbox placement test is a one-time test or an automated test

Enum12
Example: 1
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-03-14T02:17:22.035Z"
delivery_modenull or number

Whether to send emails one by one or all together

Enum ValueDescription
1

One by one

2

All together

Example: 1
descriptionstring

Description of the inbox placement test

Example: "This is a test description"
scheduleobject

Specifies the date and time when the automated inbox placement tests will be sent.

Example: {"days":{"2":true,"3":true},"timing":{"from":"02:30"},"timezone":"America/Chihuahua"}
sending_methodnumber

Whether the inbox placement test will be sent from Instantly or from outside Instantly

Enum ValueDescription
1

From Instantly

2

From Outside Instantly

Example: 1
campaign_idnull or string(uuid)

Campaign ID

Example: "01959271-1f73-794d-b682-94012c0d83fb"
email_subjectstring

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystring

Email body of the inbox placement test

Example: "Hi, this is my email body"
emailsArray of strings

Emails to send the inbox placement test to

Example: ["john@doe.com"]
test_codestring

Code for identifying the inbox placement tests in the email body from outside Instantly

Example: "ptid_9zS0YpXwuS0MAQxLdaySm"
tagsArray of strings(uuid)

List of tags to use for sending emails

Example: ["01959271-1f73-794d-b682-9402e5eb543c"]
text_onlyboolean

Disables open tracking

Example: true
recipients_labelsArray of objects

A list of email providers and their corresponding types to which emails will be sent. To retrieve the available options, use the GET: /inbox-placement-tests/email-service-provider-options endpoint

timestamp_next_runstring

Timestamp when the inbox placement test will run next

Example: "2025-03-14T02:17:22.035Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnumber

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusstring

Why the inbox placement test is currently not sending. It will be an empty string if there are no issues.

Enum ValueDescription
daily_limits_hit

Daily limits hit

other

Other reason

Example: "daily_limits_hit"
{
  "id": "01959271-1f73-794d-b682-93ffad1e5a45",
  "organization_id": "01959271-1f73-794d-b682-9400350ca566",
  "name": "My Inbox Placement Test",
  "delivery_mode": 1,
  "description": "This is a test description",
  "schedule": {
    "days": { … },
    "timing": { … },
    "timezone": "America/Chihuahua"
  },
  "type": 1,
  "sending_method": 1,
  "campaign_id": "01959271-1f73-794d-b682-94012c0d83fb",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_9zS0YpXwuS0MAQxLdaySm",
  "tags": [
    "01959271-1f73-794d-b682-9402e5eb543c"
  ],
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.035Z",
  "timestamp_next_run": "2025-03-14T02:17:22.035Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit"
}

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement analytics entry

Example: "01959271-1f6d-701a-a8f4-bef33bb9303e"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement analytics was created

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

Date when the inbox placement analytics was created

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

Organization ID

Example: "01959271-1f6d-701a-a8f4-bef4632ca526"
test_idstring(uuid)required

Inbox Placement Test ID

Example: "01959271-1f6d-701a-a8f4-bef595622cc3"
is_spamnumber

Indicates if the email landed in spam (1 for spam, 0 otherwise)

Example: 1
has_categorynumber

Indicates if the email was categorized like promotions, social, etc.

Example: 1
sender_emailstring

Email address of the sender

Example: "sender@example.com"
sender_espnumber

The sender ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_emailstring

Email address of the recipient

Example: "recipient@example.com"
recipient_espnumber

The recipient ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_geonumber

The geographic location of the recipient

Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: 1
recipient_typenumber

The type of recipient

Enum ValueDescription
1

Professional

2

Personal

Example: 1
spf_passnumber

Indicates if the email passed SPF validation (1 for pass, 0 otherwise)

Example: 1
dkim_passnumber

Indicates if the email passed DKIM validation (1 for pass, 0 otherwise)

Example: 1
dmarc_passnumber

Indicates if the email passed DMARC validation (1 for pass, 0 otherwise)

Example: 1
smtp_ip_blacklist_reportobject

Blacklist report for the SMTP IP address

authentication_failure_resultsobject

Details of authentication failures for SPF, DKIM, and DMARC

{
  "id": "01959271-1f6d-701a-a8f4-bef33bb9303e",
  "timestamp_created": "2025-03-14T02:17:22.029Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1f6d-701a-a8f4-bef4632ca526",
  "test_id": "01959271-1f6d-701a-a8f4-bef595622cc3",
  "is_spam": 1,
  "has_category": 1,
  "sender_email": "sender@example.com",
  "sender_esp": 1,
  "recipient_email": "recipient@example.com",
  "recipient_esp": 1,
  "recipient_geo": 1,
  "recipient_type": 1,
  "spf_pass": 1,
  "dkim_pass": 1,
  "dmarc_pass": 1,
  "smtp_ip_blacklist_report": {},
  "authentication_failure_results": {
    "authentication_results": "Authentication-Results: smtp.local;\r\n\tdkim=pass header.d=gappssmtp.com\r\n header.b=ABC123",
    "dkim_signature": "DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gappssmtp.com; s=20161025;\r\n h=mime-version:from:date:message-id:subject:to; bh=ABC123; b=ABC123",
    "received_spf": "Received-SPF: pass"
  }
}