Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass API key as Authorization: Bearer <api_key>.

Body

application/json

Provide exactly one target: conversation_id or contact_id. Provide exactly one of draft_message, steps, or template_id.

account_id
string
required

LinkedIn account ID returned by GET /v1/accounts.

Pattern: ^[1-9][0-9]*$
conversation_id
string
required

Existing conversation ID returned by GET /v1/conversations. Provide exactly one target.

Minimum string length: 1
contact_id
string

Contact ID returned by GET /v1/contacts or a contact import's results. Provide exactly one target.

Pattern: ^[1-9][0-9]*$
draft_message
string

Plain-text draft. Surrounding whitespace is trimmed and the existing draft for the selected compose context is replaced. Provide exactly one of draft_message, steps, or template_id.

Minimum string length: 1
steps
object[]

Ordered sequence steps staged in the conversation for the user to launch in TalkToHumans. Provide exactly one of draft_message, steps, or template_id.

Minimum array length: 1
template_id
string

Template ID returned by GET /v1/templates. Writes the draft from a message or sequence template. Provide exactly one of draft_message, steps, or template_id.

Minimum string length: 1
variables
object

Values for the template's own {{key}} variables, keyed by variable key. Only with template_id. Variables can be left unfilled by omitting them or passing an empty value; they stay in the draft for the user to fill in TalkToHumans. Keys the template does not use return 400 bad_request listing them.

Response

Draft saved in TalkToHumans. The message was not sent.

data
object
required