Send an invitation | Swarmhit Developers

A write (invite, plus a visit when the profile is opened on the way). A note over 300 characters is refused (422 too_many_characters), never cut. LinkedIn's refusals: 422 errors/cannot_resend_yet (its limit, or too soon to invite again: cool the sender down) and errors/already_invited_recently (already pending: treat as sent).

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Request Body

application/json

account_id in the body or the query.

TypeScript Definitions

Use the request body type in TypeScript.

account_id?string

The LinkedIn account (lg_…) sending the invitation. Required here or as the account_id query parameter.

Length1 <= length

provider_id*string

The member's provider id (ACoA…).

Length1 <= length

message?|

The note, 300 characters at most (longer is refused with 422, never cut). Leave it out or null to invite without a note.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/users/invite" \  -H "Content-Type: application/json" \  -d '{    "account_id": "lg_3f9c2a7b1d",    "provider_id": "ACoAAB1a2b3c4d5e6f",    "message": "Hi Jane, glad to connect."  }'

{  "object": "UserInvitationSent",  "invitation_id": "7391827364519283746"}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

502application/json

503application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`