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.
A single email verification
The verification status.
| Enum Value | Description |
|---|---|
| pending | The verification is pending |
| verified | The verification is verified |
| invalid | The verification is invalid |
The request status. Do not use this field to determine the verification status. Please use verification_status instead to check the verification status
| Enum Value | Description |
|---|---|
| success | The verification was successful |
| error | The verification was unsuccessful |
Whether this is a catch-all email address
| Enum Value | Description |
|---|---|
| false | The email is not a catch-all |
| true | The email is a catch-all |
| pending | The catch-all status is pending |
The number of verification credits available after the verification
{ "status": "success", "email": "example@example.com", "verification_status": "pending", "catch_all": true, "credits": 100, "credits_used": 1 }
A list used to store leads
Unique identifier for the lead list
Organization ID that owns this lead list
Timestamp when the lead list was created
Whether this list runs the enrichment process on every added lead or not
{ "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" }
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" }