Skip to main content
POST
Send a LinkedIn invitation

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Body

application/json
accountId
string
required

The seat to send from, by its id.

Required string length: 1 - 100
Example:

"sBzWb1QeTTqF0vUpHKa2xg"

linkedinUrl
string
required

The profile of the person to invite.

Maximum string length: 500
Pattern: ^(https?:\/\/)?([\w-]+\.)?linkedin\.com\/in\/[^\s/?#]+
Example:

"https://www.linkedin.com/in/ana-costa"

note
string

A note sent with the invitation, up to 200 characters. Left out or empty, it goes without one.

Maximum string length: 200

Response

The invitation, sent.

accountId
string
required

The seat it was sent from.

id
string

The invitation's id.

publicIdentifier
string
linkedinUrl
string