Skip to main content
PATCH
Patch inbox placement test

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the item to update

Example:

"019f985c-9332-7076-8a02-1d98b79208a9"

Body

application/json
name
string

Name of the inbox placement test

Example:

"My Inbox Placement Test"

schedule
object

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

automations
null | object[]

Optional automations to trigger based on conditions

status
enum<number> | null

Status of the inbox placement test

Available options:
1,
2,
3
Example:

1

Response

The updated Inbox Placement Test

An inbox placement test

id
string<uuid>
required
read-only

Unique identifier for the inbox placement test

Example:

"019f985c-6317-728e-9ba2-1a22dc6ef7ca"

organization_id
string<uuid>
required
read-only

Organization ID

Example:

"019f985c-6317-728e-9ba2-1a232630db67"

name
string
required

Name of the inbox placement test

Example:

"My Inbox Placement Test"

type
enum<number>
required

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

Available options:
1,
2
Example:

1

sending_method
enum<number>
required

Whether the inbox placement test will be sent from Instantly or from outside Instantly

Available options:
1,
2
Example:

1

email_subject
string
required

Email subject of the inbox placement test

Example:

"My Email Subject"

email_body
string
required

Email body of the inbox placement test

Example:

"Hi, this is my email body"

emails
string[]
required

Emails to send the inbox placement test to

recipients
string[]
required
read-only
timestamp_created
string
required
read-only

Timestamp when the inbox placement test was created

Example:

"2026-07-25T08:20:19.351Z"

delivery_mode
null | enum<number>

Whether to send emails one by one or all together

Available options:
1,
2,
null
Example:

1

description
null | string

Description of the inbox placement test

Example:

"This is a test description"

schedule
object

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

Example:
campaign_id
null | string<uuid>

Campaign ID

Example:

"019f985c-6317-728e-9ba2-1a249cea2e5a"

test_code
null | string

Code for identifying inbox placement tests sent from outside Instantly. Use ptid_ followed by letters, numbers, hyphens, or underscores. When creating a test, the ptid_ prefix is added automatically if omitted. The full code must be at most 50 characters.

Pattern: ^ptid_(?!ptid_)[A-Za-z0-9_-]{1,45}$
Example:

"ptid_qFDur3dLuxg5VGEKBrowW"

tags
null | string<uuid>[]

List of tag IDs to use for sending emails

text_only
null | boolean

Disables open tracking

Example:

true

recipients_labels
object[]

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_run
null | string

Timestamp when the inbox placement test will run next

Example:

"2026-07-25T08:20:19.351Z"

automations
null | object[]

Optional automations to trigger based on conditions

status
null | enum<number>

Status of the inbox placement test

Available options:
1,
2,
3
Example:

1

not_sending_status
null | enum<string>

Why the inbox placement test is currently not sending. It will be an empty string if there are no issues.

Available options:
daily_limits_hit,
other
Example:

"daily_limits_hit"