---
title: "Refresh the inbox"
method: POST
path: "/v1/actions/sync_inbox"
tags: ["Messages"]
---

# Refresh the inbox

`POST /v1/actions/sync_inbox`

## Request

- Base URL: `https://api.heyreagent.com`
- URL: `https://api.heyreagent.com/v1/actions/sync_inbox`
- Auth: HTTP bearer

Refresh the stored inbox from LinkedIn, or one conversation of it, in the background.

One conversation: threadOnly true AND conversationUrl; the answer has taskId. Whole inbox: neither; the answer has taskIds, one per account, and no taskId.

threadOnly true without conversationUrl runs a whole-inbox sync.

A whole-inbox sync ignores linkedinConnectionId and refreshes every account.

When a sync is already running the answer says alreadyInProgress and may carry no task id.

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

## Request body

- object
  - `conversationUrl` string: LinkedIn conversation/thread URL, or the person's profile URL. Required when threadOnly=true to fetch just that one conversation.
  - `linkedinConnectionId` string: LinkedIn account to sync from. Omit to use all active accounts for the setup.
  - `threadOnly` boolean: When true (with conversationUrl set), fetch only that one conversation thread instead of syncing the whole inbox.

## Response `200`

It worked. Inside result: success, taskId, taskIds, alreadyInProgress, expiredConnections.

- Worked
  - `ok` true, required
  - `result` object, required: What was asked for. A field that does not apply is left out, or is null.

## Other responses

- `default`: It did not work. The message says why, in plain English.

---

[API](https://skmtc.dev/heyreagent/apis/heyreagent-api.md) · [All operations](https://skmtc.dev/heyreagent/apis/heyreagent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/heyreagent/apis/heyreagent-api/revisions/917360c5f841?raw)