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.
An inbox placement test
Unique identifier for the inbox placement test
Organization ID
Whether the inbox placement test is a one-time test or an automated test
Timestamp when the inbox placement test was created
Whether to send emails one by one or all together
| Enum Value | Description |
|---|---|
| 1 | One by one |
| 2 | All together |
Specifies the date and time when the automated inbox placement tests will be sent.
Whether the inbox placement test will be sent from Instantly or from outside Instantly
| Enum Value | Description |
|---|---|
| 1 | From Instantly |
| 2 | From Outside Instantly |
Code for identifying the inbox placement tests in the email body from outside Instantly
List of tags to use for sending emails
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 when the inbox placement test will run next
Status of the inbox placement test
| Enum Value | Description |
|---|---|
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
{ "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" }
Analytics data for individual emails in inbox placement tests
Unique identifier for the inbox placement analytics entry
Timestamp when the inbox placement analytics was created
Date when the inbox placement analytics was created
Organization ID
The sender ESP (Email Service Provider)
| Enum Value | Description |
|---|---|
| 1 | |
| 2 | Microsoft |
| 12 | Web.de |
| 13 | Libero.it |
The recipient ESP (Email Service Provider)
| Enum Value | Description |
|---|---|
| 1 | |
| 2 | Microsoft |
| 12 | Web.de |
| 13 | Libero.it |
The geographic location of the recipient
| Enum Value | Description |
|---|---|
| 1 | United States |
| 2 | Italy |
| 3 | Germany |
| 4 | France |
{ "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" } }
Report data for an inbox placement test
Unique identifier for the inbox placement report entry
Timestamp when the inbox placement report was created
Date when the inbox placement report was created
Organization ID
Inbox Placement Test ID
SpamAssassin score for the email, indicating spam likelihood
{ "id": "01959271-1f6e-7be5-bc68-fdea7daed34c", "timestamp_created": "2025-03-14T02:17:22.030Z", "timestamp_created_date": "2025-03-14", "organization_id": "01959271-1f6e-7be5-bc68-fdeb50718ff2", "test_id": "01959271-1f6e-7be5-bc68-fdeced7f9434", "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 } }