This schema describes objects returned by the Inbox Placement Test endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the inbox placement test (read-only) |
organization_id | string (uuid) | Yes | Organization ID (read-only) |
name | string | Yes | Name of the inbox placement test |
delivery_mode | number, nullable | No | Whether to send emails one by one or all together. Possible values: 1 (One by one), 2 (All together) |
description | string, nullable | No | Description of the inbox placement test |
schedule | object | No | Specifies the date and time when the automated inbox placement tests will be sent. |
schedule.days | object | No | Days of the week when the test will run, where keys are integers (0-6, 0 = Sunday) and values are booleans indicating active days. |
schedule.timing | object | No | Timing configuration for the scheduled test. |
schedule.timing.from | string | No | The time of day when the test will start (24-hour format). |
schedule.timezone | string | No | Timezone in which the schedule is set, in IANA timezone format.. Possible values: Etc/GMT+12, Etc/GMT+11, Etc/GMT+10, America/Anchorage, America/Dawson, America/Creston, America/Chihuahua, America/Boise, America/Belize, America/Chicago, America/Bahia_Banderas, America/Regina, America/Bogota, America/Detroit, America/Indiana/Marengo, America/Caracas, America/Asuncion, America/Glace_Bay, America/Campo_Grande, America/Anguilla, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Argentina/La_Rioja, America/Araguaina, America/Godthab, America/Montevideo, America/Bahia, America/Noronha, America/Scoresbysund, Atlantic/Cape_Verde, Africa/Casablanca, America/Danmarkshavn, Europe/Isle_of_Man, Atlantic/Canary, Africa/Abidjan, Arctic/Longyearbyen, Europe/Belgrade, Africa/Ceuta, Europe/Sarajevo, Africa/Algiers, Africa/Windhoek, Asia/Nicosia, Asia/Beirut, Africa/Cairo, Asia/Damascus, Europe/Bucharest, Africa/Blantyre, Europe/Helsinki, Europe/Istanbul, Asia/Jerusalem, Africa/Tripoli, Asia/Amman, Asia/Baghdad, Europe/Kaliningrad, Asia/Aden, Africa/Addis_Ababa, Europe/Kirov, Europe/Astrakhan, Asia/Tehran, Asia/Dubai, Asia/Baku, Indian/Mahe, Asia/Tbilisi, Asia/Yerevan, Asia/Kabul, Antarctica/Mawson, Asia/Yekaterinburg, Asia/Karachi, Asia/Kolkata, Asia/Colombo, Asia/Kathmandu, Antarctica/Vostok, Asia/Dhaka, Asia/Rangoon, Antarctica/Davis, Asia/Novokuznetsk, Asia/Hong_Kong, Asia/Krasnoyarsk, Asia/Brunei, Australia/Perth, Asia/Taipei, Asia/Choibalsan, Asia/Irkutsk, Asia/Dili, Asia/Pyongyang, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Melbourne, Antarctica/DumontDUrville, Australia/Currie, Asia/Chita, Antarctica/Macquarie, Asia/Sakhalin, Pacific/Auckland, Etc/GMT-12, Pacific/Fiji, Asia/Anadyr, Asia/Kamchatka, Etc/GMT-13, Pacific/Apia |
type | number | Yes | Whether the inbox placement test is a one-time test or an automated test. Possible values: 1, 2 |
sending_method | number | Yes | Whether the inbox placement test will be sent from Instantly or from outside Instantly. Possible values: 1 (From Instantly), 2 (From Outside Instantly) |
campaign_id | string (uuid), nullable | No | Campaign ID |
email_subject | string | Yes | Email subject of the inbox placement test |
email_body | string | Yes | Email body of the inbox placement test |
emails | array | Yes | Emails to send the inbox placement test to |
test_code | string, nullable | No | Code for identifying the inbox placement tests in the email body from outside Instantly |
tags | array, nullable | No | List of tag IDs to use for sending emails |
text_only | boolean, nullable | No | Disables open tracking |
recipients | array | Yes | Read-only |
recipients_labels | array | No | 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 |
recipients_labels[].region | string | No | The region to send emails to |
recipients_labels[].sub_region | string | No | The sub-region to send emails to |
recipients_labels[].type | string | No | The type of email to send |
recipients_labels[].esp | string | No | The Email Service Provider (ESP) to send emails to |
timestamp_created | string | Yes | Timestamp when the inbox placement test was created (read-only) |
timestamp_next_run | string, nullable | No | Timestamp when the inbox placement test will run next |
automations | array, nullable | No | Optional automations to trigger based on conditions |
status | number, nullable | No | Status of the inbox placement test. Possible values: 1 (Active), 2 (Paused), 3 (Completed) |
not_sending_status | string, nullable | No | Why the inbox placement test is currently not sending. It will be an empty string if there are no issues.. Possible values: daily_limits_hit (Daily limits hit), other (Other reason) |