v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

InboxPlacementTest

List inbox placement test

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

get/api/v2/inbox-placement-tests

Query parameters

limitinteger

Example:10

The number of items to return

starting_afterstring

Example:01956fbd-0eb1-72db-a565-82977a586084

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.

searchstring

Example:test

status1 | 2 | 3

Example:1

sort_order'asc' | 'desc'

Example:desc

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

Response

The list of Inbox Placement Test

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 response

{
  "items": [
    {
      "id": "019f94cd-83af-7ac5-acf5-0f661da52ad9",
      "organization_id": "019f94cd-83af-7ac5-acf5-0f67604a4657",
      "name": "My Inbox Placement Test",
      "delivery_mode": 1,
      "description": "This is a test description",
      "schedule": {
        "days": {
          "2": true,
          "3": true
        },
        "timing": {
          "from": "02:30"
        },
        "timezone": "America/Chihuahua"
      },
      "type": 1,
      "sending_method": 1,
      "campaign_id": "019f94cd-83af-7ac5-acf5-0f68a4abdeac",
      "email_subject": "My Email Subject",
      "email_body": "Hi, this is my email body",
      "emails": [
        "john@doe.com"
      ],
      "test_code": "ptid_ywYL4giOvjmGfhXDhI6JC",
      "tags": [
        "019f94cd-83af-7ac5-acf5-0f692bce3808"
      ],
      "text_only": true,
      "recipients": [
        "johndoe@instantly.ai"
      ],
      "recipients_labels": [
        {
          "region": "North America",
          "sub_region": "US",
          "type": "Professional",
          "esp": "Google"
        }
      ],
      "timestamp_created": "2026-07-24T15:45:24.399Z",
      "timestamp_next_run": "2026-07-24T15:45:24.399Z",
      "automations": [
        {
          "when": {
            "condition": "placement_goes_below",
            "condition_value": 80
          },
          "then": {
            "webhook_url": "https://example.com/webhook",
            "pause_sending_campaigns_for": 14,
            "pause": true,
            "enable_slow_ramp": true,
            "disable_slow_ramp": true,
            "add_tags": [
              "019f94cd-83af-7ac5-acf5-0f6b51f6e50e"
            ],
            "remove_tags": [
              "019f94cd-83af-7ac5-acf5-0f6c269291d5"
            ]
          }
        }
      ],
      "status": 1,
      "not_sending_status": "daily_limits_hit"
    }
  ],
  "next_starting_after": "019f94cd-aeb6-7103-b32f-a0c4dae3aed4"
}