Skip to main content
POST
Find or start conversation

Body

application/json
accountId
string

Optional. The connected account. When left out, one on that network is picked.

platform
enum<string>

The network. Needed with platformId; taken from the lead when you send prospectId.

Available options:
x,
linkedin
platformId
string

The person's network ID.

prospectId
string

Or a lead ID instead of platform and platformId.

Response

OK. Check status: errors the API handles itself also return 200.

status
boolean
required

true when the request succeeded.

data
object
required
error
null
required

Always null on success.