Docs / Messages

`mark_read`

Mark one conversation read in the stored inbox.

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

What you give it

Input	What it is	Where to get it
`readKey` needed	A read key. readKey returned by list_conversations	Run `list_conversations` and use `inbox[].readKey` from its answer.

Call it

curl -X POST https://api.heyreagent.com/v1/actions/mark_read \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"readKey":"PASTE_READ_KEY_HERE"}'

The same call in JavaScript

const response = await fetch("https://api.heyreagent.com/v1/actions/mark_read", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "readKey": "PASTE_READ_KEY_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/mark_read",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "readKey": "PASTE_READ_KEY_HERE",
    },
)
print(response.json())

The same call in n8n

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

Method	`POST`
URL	`https://api.heyreagent.com/v1/actions/mark_read`
Send Headers	On. Name `Authorization`, Value `Bearer YOUR_KEY`
Send Body	On. Body Content Type `JSON`, Specify Body `Using JSON`, then paste the body below

{
  "readKey": "PASTE_READ_KEY_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:

success

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

It changes this app's copy only; LinkedIn is not told. set_chat_status marks a conversation read on LinkedIn itself.
Any text is accepted as readKey and answered with success, so a stale key fails silently.

In Claude or ChatGPT

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