Messages

Refresh the inbox

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

post/v1/actions/sync_inbox

Request

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

Request body

conversationUrlstring

LinkedIn conversation/thread URL, or the person's profile URL. Required when threadOnly=true to fetch just that one conversation.

linkedinConnectionIdstring

LinkedIn account to sync from. Omit to use all active accounts for the setup.

threadOnlyboolean

When true (with conversationUrl set), fetch only that one conversation thread instead of syncing the whole inbox.

Response

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

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.