Start a chat

Starts a new chat thread (LinkedIn, WhatsApp, etc.) with one or more attendees from a connected account and sends the first message. This delivers a real message as a side effect. When delivering a saved draft, pass both draftMessageId and its opaque draftRevision so a newer edit cannot be consumed.

Authorization

apiKeyAuth

x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

connectedAccountId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

attendeeIdentifiers*array<>

Items1 <= items

text*string

Lengthlength <= 20000

chatName?string

Optional display name for the new chat (group chats)

Lengthlength <= 998

linkedinProduct?string

LinkedIn only: which product to send from. classic (default), sales_navigator or recruiter start the chat from that product's inbox; the two latter send an InMail and require inmailSubject (recruiter also inmailSignature)

Value in"classic" | "sales_navigator" | "recruiter"

inmail?boolean

LinkedIn classic only: send as InMail to message people outside your network (uses InMail credit)

inmailSubject?string

Subject line of the InMail. Required for sales_navigator and recruiter

Lengthlength <= 998

inmailSignature?string

Sender signature. Required for recruiter

Lengthlength <= 998

attachments?array<>

Itemsitems <= 20

draftMessageId?string

Saved new-conversation draft to reconcile after delivery

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

draftRevision?string

Opaque revision returned with the saved draft; required whenever draftMessageId is provided

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

Response Body

`application/json`

curl -X POST "https://loading/api/v1/messaging/start-chat" \  -H "Content-Type: application/json" \  -d '{    "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",    "attendeeIdentifiers": [      "string"    ],    "text": "string"  }'

{
  "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e"
}

"string"

"string"

"string"

"string"

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`