Docs / Messages

`sync_inbox`

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

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
`conversationUrl` optional	A conversation link or a profile link. LinkedIn conversation/thread URL, or the person's profile URL. Required when threadOnly=true to fetch just that one conversation.	Open the person's profile on LinkedIn and copy the address from your browser. It looks like https://www.linkedin.com/in/their-name Or run `search_people` and use `people[].profileUrl` from its answer. 30 more places to get it `list_conversations` → `inbox[].conversationUrl` `get_my_profile` → `accounts[].profileUrl` `list_connections` → `connections[].profileUrl` `list_sent_invitations` → `pendingInvitations[].profileUrl` `list_received_invitations` → `invitations[].profileUrl` `list_followers` → `followers[].profileUrl` `list_conversations` → `inbox[].participantProfileUrl` `list_chat_attendees` → `attendees[].profileUrl` `list_inmail` → `inmail[].participant.profileUrl` `search_posts` → `posts[].author.profileUrl` `search_linkedin_people` → `results[].publicProfileUrl` `search_linkedin_people` → `results[].profileUrl` `search_linkedin_sales_navigator_people` → `results[].publicProfileUrl` `who_is_waiting_on_me` → `waitingOnYou[].profileUrl` `who_went_cold` → `coldConversations[].profileUrl` `connections_never_messaged` → `leads[].profileUrl` `get_profile_details` → `publicProfileUrl` `get_conversation` → `participant.profileUrl` `list_chat_participants` → `participants[].profileUrl` `get_chat_attendee` → `profileUrl` `get_inmail_conversation` → `participant.profileUrl` `get_post_engagers` → `reactors[].linkedinUrl` `get_post_engagers` → `commenters[].linkedinUrl` `list_post_comments` → `comments[].authorDetails.profileUrl` `list_post_reactions` → `reactions[].author.profileUrl` `list_job_applicants` → `applicants[].publicProfileUrl` `get_job_applicant` → `publicProfileUrl` `engagers_not_connected` → `leads[].profileUrl` `search_people_sales_navigator` → `leads[].linkedinUrl` `find_decision_makers` → `leads[].linkedinUrl`
`linkedinConnectionId` optional	A connection id. LinkedIn account to sync from. Omit to use all active accounts for the setup.	Run `list_linkedin_accounts` and use `accounts[].id` from its answer. 15 more places to get it `get_my_profile` → `accounts[].connectionId` `list_connections` → `connections[].connectionId` `list_connections` → `summary.accounts[].connectionId` `list_sent_invitations` → `pendingInvitations[].connectionId` `preview_withdraw_invitations` → `breakdown[].linkedinConnectionId` `list_conversations` → `inbox[].linkedinConnectionId` `list_inmail` → `inmail[].connectionId` `get_inmail_credits` → `accounts[].connectionId` `list_sales_navigator_contracts` → `accounts[].connectionId` `who_is_waiting_on_me` → `waitingOnYou[].connectionId` `who_went_cold` → `coldConversations[].connectionId` `connections_never_messaged` → `summary.accounts[].connectionId` `get_usage` → `connectionId` `get_conversation` → `connectionId` `get_inmail_conversation` → `connectionId`
`threadOnly` optional	True or false. When true (with conversationUrl set), fetch only that one conversation thread instead of syncing the whole inbox.	You write it.

Call it

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

The same call in JavaScript

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

The same call in Python

import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/sync_inbox",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={},
)
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/sync_inbox`
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

{}

Put your own key where it says YOUR_KEY. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

`success`
`taskId`	A task id. Other actions take it.
`taskIds`
`alreadyInProgress`
`expiredConnections`

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

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.

In Claude or ChatGPT

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