Messages

Get a conversation

Read your whole conversation with one person.

chatId and participant come back only when source is "live". An answer from the stored copy (source "cache") has neither; refresh true forces a live read.

A linkedin.com/messaging/thread/… link works only for a stored conversation. For a live read pass the person's profile link.

For an InMail, Sales Navigator or Recruiter conversation the answer adds replyWith with the chatId: reply there with send_chat_message. send_message by profile link would start an ordinary conversation instead.

exists false with uncertain true means it could not be checked, not that there is no conversation.

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

post/v1/actions/get_conversation

Request

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

Request body

conversationUrlstring required

The other person's LinkedIn profile URL (https://linkedin.com/in/…) — preferred — or a /messaging/thread/ URL.

connectionIdstring

Which of your senders owns this conversation (its linkedinConnections _id). Omit to search your live senders; for a live fetch the first live sender is used.

refreshboolean

true = fetch live from LinkedIn even if cached. false (default) = return the cached thread when available, else fetch live.

Response

It worked. Inside result: source, connectionId, exists, participant, chatId, inbox, messageCount, messages, note.

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.