Docs / Network

send_invitation

Send one connection invitation, now.

This action can change or spend something, and when it does it happens right away. Read “Good to know” first.

What you give it

InputWhat it isWhere to get it
profileUrl
needed
A profile link. The person's LinkedIn profile URL (linkedin.com/in/…).Open the person's profile on LinkedIn and copy the address from your browser. It looks like https://www.linkedin.com/in/their-name
Or run search_people and use people[].profileUrl from its answer.
29 more places to get it
note
optional
Text, up to 300 characters. Optional note sent with the invitation (max 300 characters).You write it.
email
optional
An email address. The person's email address — only for someone whose LinkedIn settings ask for it before they can be invited.You write it.
connectionId
optional
A connection id. Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.Run list_linkedin_accounts and use accounts[].id from its answer.
15 more places to get it

Call it

curl -X POST https://api.heyreagent.com/v1/actions/send_invitation \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"profileUrl":"PASTE_PROFILE_LINK_HERE"}'
The same call in JavaScript
const response = await fetch("https://api.heyreagent.com/v1/actions/send_invitation", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "profileUrl": "PASTE_PROFILE_LINK_HERE"
  }),
});
const answer = await response.json();
console.log(answer);
The same call in Python
import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/send_invitation",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "profileUrl": "PASTE_PROFILE_LINK_HERE",
    },
)
print(response.json())
The same call in n8n

Add an HTTP Request node and fill it in like this:

MethodPOST
URLhttps://api.heyreagent.com/v1/actions/send_invitation
Send HeadersOn. Name Authorization, Value Bearer YOUR_KEY
Send BodyOn. Body Content Type JSON, Specify Body Using JSON, then paste the body below
{
  "profileUrl": "PASTE_PROFILE_LINK_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

sent
profileUrl
invitationIdA sent invitation id. Other actions take it.
withNote
fromthe account it ran on
usedTodaynumber
dailyLimitnumber

A field that does not apply to an answer is left out, or is null.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

Good to know

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, send_invitation, and the same inputs.