Skip to main content
POST
Send message to lead by ID
Requires inbox:send. Supply the campaign lead ID in the path and senderId plus message in the body. message is limited to 1–8,000 characters. campaignId is optional. Supported lead-name variables, such as {{firstName}}, are resolved from the lead. Review your message before sending. Unlike MCP’s preview-and-confirm flow, a valid REST request acts immediately. Use an Idempotency-Key. After an uncertain outcome, read the conversation before trying again.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Path Parameters

leadId
string
required

Body

application/json
senderId
string
required

LinkedIn sender ID to use

Example:

"sender_123"

message
string
required

Message content to send

Required string length: 1 - 8000
Example:

"Hi {{firstName}}, I wanted to follow up on our conversation..."

campaignId
string

Optional campaign ID to associate this message with

Response

Message sent or queued

success
boolean
required

Success status

Example:

true

messageId
string
required

Message ID

Example:

"msg_123"

recipientLinkedinUrl
string
required

Recipient LinkedIn URL

status
enum<string>
required

Message status

Available options:
queued,
sent,
failed
Example:

"sent"

timestamp
string<date-time>
required

Timestamp when message was sent/queued

leadId
string

Lead ID if message was sent to a lead

conversationId
string

LinkedIn conversation ID, when the provider returns one (use with GET /v1/inbox/conversations/:conversationId/messages)

error
string

Error message if failed