Skip to main content
POST
Send LinkedIn message
Requires inbox:send. Required fields are senderId, recipientLinkedinUrl, and message (1–8,000 characters). campaignId and leadId are optional associations; they do not replace the required recipient URL. This REST request sends when accepted. For a campaign-lead target and supported name variables, use Send to Lead. Use an Idempotency-Key. Sender limits apply independently of API rate limits. If delivery is uncertain, inspect the conversation before retrying; do not switch keys to force a second send.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Body

application/json
senderId
string
required

LinkedIn sender ID to use (must be connected to workspace)

Example:

"sender_123"

recipientLinkedinUrl
string
required

LinkedIn URL of the recipient (must be a 1st degree connection)

Example:

"https://www.linkedin.com/in/johndoe/"

message
string
required

Message content to send

Required string length: 1 - 8000
Example:

"Hi John, I wanted to follow up on our conversation..."

campaignId
string

Optional campaign ID to associate this message with

Example:

"campaign_123"

leadId
string

Optional lead ID to associate this message with

Example:

"lead_123"

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