Docs / Messages

start_conversation

Start a new conversation: an InMail, a message through Sales Navigator or Recruiter, a group, a company page, a job applicant.

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

What you give it

Call it

curl -X POST https://api.heyreagent.com/v1/actions/start_conversation \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"to":["PASTE_PROFILE_LINK_HERE"],"text":"Hello!"}'

const response = await fetch("https://api.heyreagent.com/v1/actions/start_conversation", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "to": [
      "PASTE_PROFILE_LINK_HERE"
    ],
    "text": "Hello!"
  }),
});
const answer = await response.json();
console.log(answer);

import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/start_conversation",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "to": ["PASTE_PROFILE_LINK_HERE"],
        "text": "Hello!",
    },
)
print(response.json())

{
  "to": [
    "PASTE_PROFILE_LINK_HERE"
  ],
  "text": "Hello!"
}

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:

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

• The id must match the product in via: a member id or a profile link for "classic", a Sales Navigator id for "sales_navigator", a Recruiter id for "recruiter".
• A company page is written to at its company messaging id (get_company → messaging.id), with companyTopic set; its company id does not work here.
• An InMail spends one credit unless the person has an open profile: check get_inmail_credits, and isOpenProfile on get_profile_details.
• inmail true is added to the answer when the send was an InMail.

In Claude or ChatGPT

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