Skip to main content
POST
Sync Inbox
Imports the messages already in an account’s inbox into your webhooks — typically right after connecting it, to build the inbox in your product before real time takes over. Covers the classic inbox and the connected Sales Navigator / Recruiter seats. The sync runs in the background (~20 minutes for 100 conversations). Every message is delivered exactly like a real-time message webhook, grouped per conversation: each POST carries up to 25 messages under events, with sync_id and catch_up: true at the top level. Messages already delivered to your webhooks are skipped, and your webhook’s message_type filter applies.
This endpoint is free — it does not consume any credits. One sync at a time per account, 10 per 24 hours.
The account needs an active webhook subscribed to messages (events: all or message_received). Set message_type: "all" on it to also import the messages the account sent.

Path Parameters

string
required
A LinkedIn account of your API key

Header Parameters

string
required
Your API key

Body Parameters

integer
Only conversations and messages from this point on, in epoch milliseconds. Omit it to import the whole inbox (within the limits below)
string
default:"all"
all, classic, sales_nav or recruiter. all syncs every inbox connected on the account
integer
default:100
Most recent conversations to import, 1 to 500
integer
default:200
Most recent messages per conversation, 1 to 200. Older ones: get_conversation with cursor

Response

object

Follow a sync

GET /v2/accounts/{account_id}/sync/{sync_id} returns the same object (without estimated_minutes), updated as the sync progresses. Free. 404 when the sync does not exist on this account.

Notes

  • A sync is completed when at least one of its inboxes succeeded; check inboxes.<inbox>.status for each one
  • Synced messages can be months old: skip those carrying sync_id / catch_up: true in automations that react to incoming messages
  • Each item of events is the event object of a real-time message webhook — see Build an Inbox for a parser handling both
  • 409 when a sync is already running on the account, 429 after 10 syncs in 24 hours
  • LinkedIn accounts only