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 Test

An inbox placement test

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
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
sending_methodnumberrequired

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
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

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

Emails to send the inbox placement test to

Example: ["john@doe.com"]
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
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
descriptionnull or string

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"}
campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
test_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

text_onlynull or boolean

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_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

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": "0199f372-f000-7818-985b-6d0cca8f5fb2",
  "organization_id": "0199f372-f000-7818-985b-6d0db4370ab2",
  "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": "0199f372-f001-746a-bba4-f24ea414ca49",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_n866TPUb8dmXToCHgf5XL",
  "tags": null,
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-10-17T18:33:40.097Z",
  "timestamp_next_run": "2025-10-17T18:33:40.097Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit"
}

Create inbox placement test

Request

Requires one of the following scopes: inbox_placement_tests:create, inbox_placement_tests:all, all:create, all:all

Bodyapplication/jsonrequired

The Inbox Placement Test to create

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
sending_methodnumberrequired

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
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

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

Emails to send the inbox placement test to

Example: ["john@doe.com"]
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 or null

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.

campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
test_codestring or null

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

Example: ["0199f372-f001-746a-bba4-f24fa5838cd9"]
text_onlyboolean or null

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 or null

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnumber or null

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusstring or null

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"
run_immediatelyboolean

Run the test immediately after creation, as well as on the schedule

Example: true
curl -i -X POST \
  https://api.instantly.ai/api/v2/inbox-placement-tests \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Inbox Placement Test",
    "type": 1,
    "sending_method": 1,
    "email_subject": "My Email Subject",
    "email_body": "Hi, this is my email body",
    "emails": [
      "john@doe.com"
    ]
  }'

Responses

The Inbox Placement Test

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
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
sending_methodnumberrequired

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
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

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

Emails to send the inbox placement test to

Example: ["john@doe.com"]
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
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
descriptionnull or string

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"}
campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
test_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

text_onlynull or boolean

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_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

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"
Response
application/json
{
  "id": "0199f372-f000-7818-985b-6d0cca8f5fb2",
  "organization_id": "0199f372-f000-7818-985b-6d0db4370ab2",
  "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": "0199f372-f001-746a-bba4-f24ea414ca49",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_n866TPUb8dmXToCHgf5XL",
  "tags": null,
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-10-17T18:33:40.097Z",
  "timestamp_next_run": "2025-10-17T18:33:40.097Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit"
}

List inbox placement test

Request

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

Query
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
searchstring
Example: search=test
statusnumber
Enum123
Example: status=1
sort_orderstring

Sort order for the results. Results are always sorted by id (which is timestamp-sorted due to UUIDv7).

Enum"asc""desc"
Example: sort_order=desc
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-tests?limit=10&search=test&sort_order=desc&starting_after=01956fbd-0eb1-72db-a565-82977a586084&status=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Inbox Placement Test

Bodyapplication/json
itemsArray of objects(Inbox Placement Test)required

The list of Inbox Placement Test

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

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
items[].​namestringrequired

Name of the inbox placement test

Example: "My Inbox Placement Test"
items[].​typenumberrequired

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

Enum12
Example: 1
items[].​sending_methodnumberrequired

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
items[].​email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
items[].​email_bodystringrequired

Email body of the inbox placement test

Example: "Hi, this is my email body"
items[].​emailsArray of stringsrequired

Emails to send the inbox placement test to

Example: ["john@doe.com"]
items[].​recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
items[].​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
items[].​descriptionnull or string

Description of the inbox placement test

Example: "This is a test description"
items[].​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"}
items[].​campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
items[].​test_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
items[].​tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

items[].​text_onlynull or boolean

Disables open tracking

Example: true
items[].​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

items[].​timestamp_next_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
items[].​automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

items[].​statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
items[].​not_sending_statusnull or string

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"
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: "0199f373-0f77-7b00-8fdf-51404fda701d"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0199f373-0f77-7b00-8fdf-51404fda701d"
}

Get inbox placement test

Request

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

Path
idstring(uuid)required

The ID of the requested item

Example: 0199f373-0f78-7ded-8e3b-8b6ed700be69
Query
with_metadataboolean

Whether to include additional metadata about the inbox placement test

Example: with_metadata=true
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-tests/0199f373-0f78-7ded-8e3b-8b6ed700be69?with_metadata=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Inbox Placement Test

Bodyapplication/json
idstring(uuid)read-only

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
organization_idstring(uuid)read-only

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
namestring

Name of the inbox placement test

Example: "My Inbox Placement Test"
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
descriptionnull or string

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.

typenumber

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

Enum12
Example: 1
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: "0199f372-f001-746a-bba4-f24ea414ca49"
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_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

Example: ["0199f372-f001-746a-bba4-f24fa5838cd9"]
text_onlynull or boolean

Disables open tracking

Example: true
recipientsArray of stringsread-only
Example: ["johndoe@instantly.ai"]
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_createdstringread-only

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
timestamp_next_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

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"
metadataobject

Included only when the with_metadata parameter is true. Contains additional information about the inbox placement test as associated campaign details and tags.

Example: {"campaign":{"id":"campaign-id","name":"Campaign Name"},"tags":{"tag-id":{"id":"tag-id","label":"Tag Label"}}}
Response
application/json
{
  "id": "0199f372-f000-7818-985b-6d0cca8f5fb2",
  "organization_id": "0199f372-f000-7818-985b-6d0db4370ab2",
  "name": "My Inbox Placement Test",
  "delivery_mode": 1,
  "description": "This is a test description",
  "schedule": {
    "days": { … },
    "timing": { … },
    "timezone": "Etc/GMT+12"
  },
  "type": 1,
  "sending_method": 1,
  "campaign_id": "0199f372-f001-746a-bba4-f24ea414ca49",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_n866TPUb8dmXToCHgf5XL",
  "tags": null,
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-10-17T18:33:40.097Z",
  "timestamp_next_run": "2025-10-17T18:33:40.097Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit",
  "metadata": {
    "campaign": { … },
    "tags": { … }
  }
}

Delete inbox placement test

Request

Requires one of the following scopes: inbox_placement_tests:delete, inbox_placement_tests:all, all:delete, all:all

Path
idstring(uuid)required

The ID of the item to delete

Example: 0199f373-0f7a-72aa-ae93-4eec01cd3f42
Bodyapplication/json
null
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/inbox-placement-tests/0199f373-0f7a-72aa-ae93-4eec01cd3f42 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

The deleted Inbox Placement Test

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
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
sending_methodnumberrequired

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
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

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

Emails to send the inbox placement test to

Example: ["john@doe.com"]
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
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
descriptionnull or string

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"}
campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
test_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

text_onlynull or boolean

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_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

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"
Response
application/json
{
  "id": "0199f372-f000-7818-985b-6d0cca8f5fb2",
  "organization_id": "0199f372-f000-7818-985b-6d0db4370ab2",
  "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": "0199f372-f001-746a-bba4-f24ea414ca49",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_n866TPUb8dmXToCHgf5XL",
  "tags": null,
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-10-17T18:33:40.097Z",
  "timestamp_next_run": "2025-10-17T18:33:40.097Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit"
}

Patch inbox placement test

Request

Requires one of the following scopes: inbox_placement_tests:update, inbox_placement_tests:all, all:update, all:all

Path
idstring(uuid)required

The ID of the item to update

Example: 0199f373-0f7a-72aa-ae93-4eedbd906947
Bodyapplication/json
non-empty
namestring

Name of the inbox placement test

Example: "My Inbox Placement Test"
scheduleobject

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

automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnumber or null

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
curl -i -X PATCH \
  https://api.instantly.ai/api/v2/inbox-placement-tests/0199f373-0f7a-72aa-ae93-4eedbd906947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Inbox Placement Test

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "0199f372-f000-7818-985b-6d0cca8f5fb2"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "0199f372-f000-7818-985b-6d0db4370ab2"
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
sending_methodnumberrequired

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
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

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

Emails to send the inbox placement test to

Example: ["john@doe.com"]
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-17T18:33:40.097Z"
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
descriptionnull or string

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"}
campaign_idnull or string(uuid)

Campaign ID

Example: "0199f372-f001-746a-bba4-f24ea414ca49"
test_codenull or string

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

Example: "ptid_n866TPUb8dmXToCHgf5XL"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

text_onlynull or boolean

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_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-17T18:33:40.097Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

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"
Response
application/json
{
  "id": "0199f372-f000-7818-985b-6d0cca8f5fb2",
  "organization_id": "0199f372-f000-7818-985b-6d0db4370ab2",
  "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": "0199f372-f001-746a-bba4-f24ea414ca49",
  "email_subject": "My Email Subject",
  "email_body": "Hi, this is my email body",
  "emails": [
    "john@doe.com"
  ],
  "test_code": "ptid_n866TPUb8dmXToCHgf5XL",
  "tags": null,
  "text_only": true,
  "recipients": [
    "johndoe@instantly.ai"
  ],
  "recipients_labels": [
    { … }
  ],
  "timestamp_created": "2025-10-17T18:33:40.097Z",
  "timestamp_next_run": "2025-10-17T18:33:40.097Z",
  "automations": null,
  "status": 1,
  "not_sending_status": "daily_limits_hit"
}

Get ESP options

Request

Provides a list of available email service providers for inbox placement tests.

curl -i -X GET \
  https://api.instantly.ai/api/v2/inbox-placement-tests/email-service-provider-options \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
regionstringrequired
Example: "North America"
sub_regionstringrequired
Example: "US"
typestringrequired
Example: "Professional"
espstringrequired
Example: "Google"
]
Response
application/json
[
  {
    "region": "North America",
    "sub_region": "US",
    "type": "Professional",
    "esp": "Google"
  }
]

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 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

Schemas