API referenceDirect actions
POST
/accounts/{id}/inmails

JavaScript SDK: swarmhit.accounts.inmails.send(accountId, params)

Send a LinkedIn InMail from this sender account to a non-connection. InMail requires a premium LinkedIn plan on the sender (free senders cannot send any). Sales Navigator and Recruiter senders InMail open profiles free up to a monthly allowance (about 800/month, plan-dependent); every other send, including classic Premium, draws the sender's InMail credit balance (visible as inmailCredits on the account). Counts against the sender's daily InMail cap. Fails with 409 code: sender_paused when the sender is paused, 409 code: inmail_not_available when the sender has no premium InMail access, and 429 code: inmail_credits_exhausted (details.scope: inmail_credits) when the sender is out of InMail credits.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Unique key per action (e.g. a UUID). Reusing it replays the first response instead of sending again, so a retry can't double-send. Read only by the endpoints that list it. A key is scoped to the endpoint and the account (or chat) it acts on, and kept for 24 hours. Only a successful response is stored and replayed: a 4xx frees the key, while a 5xx keeps it (the action may have gone out; retry with a new key). So does a 400 passing on a LinkedIn, WhatsApp or mail provider failure (code provider-unreachable, provider-408 for the provider's own timeout, or provider- and a 5xx status such as provider-502), unless the request provably never reached the provider (its connection never opened): the action may have gone out. A retry with the same key then gets 409 idempotency_failed. The request body is not compared, so a reused key replays the first response even if the body differs.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/accounts/string/inmails" \  -H "Content-Type: application/json" \  -d '{    "profileUrl": "string",    "text": "string"  }'
{  "data": {    "id": "string",    "accountId": "string",    "type": "invitation",    "status": "pending",    "profileUrl": "string",    "publicIdentifier": "string",    "postUrl": "string",    "replyTo": "string",    "reactionType": "like",    "leadId": "string",    "note": "string",    "error": "string",    "sentAt": "2019-08-24T14:15:22Z",    "acceptedAt": "2019-08-24T14:15:22Z",    "withdrawnAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}