Messages

Start a conversation (InMail, group, company)

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

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.

Docs: https://heyreagent.com/docs/actions/start_conversation

post/v1/actions/start_conversation

Request

  • Base URL: https://api.heyreagent.com
  • URL: https://api.heyreagent.com/v1/actions/start_conversation
  • Auth: HTTP bearer

Request body

tostring[] required

Who to write to: LinkedIn profile URLs or member ids. One person, or several for a group conversation. For a company page pass its messaging id.

textstring required

The first message.

subjectstring

Subject line (InMail).

via'classic' | 'sales_navigator' | 'recruiter'

Which LinkedIn product sends it. sales_navigator and recruiter need that seat on your account.

inmailboolean

classic only: send as an InMail (to someone you are not connected to).

companyTopic'service_request' | 'request_demo' | 'support' | 'careers' | 'other'

Required when writing to a company page.

applicantIdstring

Required when writing to an applicant of your job posting (from list_job_applicants).

invitationIdstring

Required when writing to someone whose invitation you have neither accepted nor declined (from list_received_invitations).

groupIdstring

Required when writing to someone through a LinkedIn group you share. A LinkedIn group you share with the person. No action here lists your groups.

attachmentUrlsstring[]

Files or images to attach. Public https links; each file up to 10 MB, 20 MB in total.

voiceMessageUrlstring uri

An audio file to send as a voice note (.m4a preferred). A public https link, up to 10 MB.

videoMessageUrlstring uri

A video file to send as a video note. A public https link, up to 10 MB.

connectionIdstring

Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.

Response

It worked. Inside result: sent, chatId, messageId, from, usedToday, dailyLimit.

oktrue required
resultobject required

What was asked for. A field that does not apply is left out, or is null.

Changes

No recorded changes to this operation across all 1 revision of this API.