Skip to content

Prepare Sequence Inmail

POST
/sequences/{sequence_id}/inmail/{step_id}/prepare

Start checking which contacts can receive a free InMail at this step. NEVER sends a message.

Returns the job (job_id, status); a preparation already running for the step is returned instead of a second one. Needs write access to the sequence.

Authorizations

Parameters

Path Parameters

sequence_id
required

Sequence id.

string

Sequence id.

step_id
required

Step id of the LinkedIn InMail step.

string

Step id of the LinkedIn InMail step.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
contact_ids
Any of:
Array<integer>
>= 1 items <= 500 items

Responses

200

Successful Response

object
data
required

An InMail preparation job, its per-contact readiness rows, or a cancel result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string