API Reference/Endpoints

Send an invitation

POST/api/linkedin/gateway/users/invite

Sends a connection request from the connected account to a target LinkedIn member, with an optional note attached. This is the lower-level route behind connection requests — it needs the target's provider id rather than a profile URL.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401. The account behind account_id must belong to your key.

Body parameters

FieldTypeDescription

account_id *stringWhich connected account sends the invite.

provider_id *stringThe target's LinkedIn provider id — resolve one first with Retrieve a profile.

messagestringAn optional note to include, up to 300 characters.

user_emailstringThe target's email — only needed on the rare invite that requires confirming it.

Response fields

FieldTypeDescription

invitation_idstringIdentifies this invitation, e.g. to cancel it later.

usagenumberPercentage of the account's invite quota already used for the period, when reported.

LinkedIn enforces hard caps on how many invitations an account can send in a day or week, and flags accounts that burst through them. Pace sends out, and watch the usage field rather than firing invites in a tight loop.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.·422 Unprocessable Entity. The target is already a connection, was invited too recently, or isn't open to an invite from this account right now.