v1

latestOpenAPI 3.0.02026-07-249301.3 MB

Accounts

Resynchronize account messaging data

This route can be used both to initiate a sync process (from scratch or within a specific time span) and to monitor its status via regular polling. Supported providers: LinkedIn and Telegram. Instagram and WhatsApp are not supported by this route.

get/api/v1/accounts/{account_id}/sync

Path parameters

account_idstring required

The id of the account to resynchronize.

Query parameters

chunk_sizenumber

The number of chats to be synchronized in a single chunk. Supported for LinkedIn and Telegram.

partialboolean

LinkedIn only. Whether the account should be partially resynchronized (keeping already synced data) or fully resynchronized.

linkedin_product'classic' | 'recruiter' | 'sales_navigator'

LinkedIn only. The LinkedIn messaging feature to synchronize. Leave blank to process all connected features.

beforenumber

The end of the time span (lowest Epoch time in ms). Supported for LinkedIn and Telegram.

afternumber

The start of the time span (highest Epoch time in ms). Supported for LinkedIn and Telegram.

Response

OK. Request succeeded.

object'AccountResync' required

status'SYNC_STARTED' | 'SYNC_RUNNING' | 'SYNC_DONE' | 'SYNC_ERROR' | 'CHUNK_DONE' required

The status of the synchronization. You can setup a regular polling on the same route to get updates on its status. A new request after a SYNC_DONE, CHUNK_DONE or SYNC_ERROR response will start a fresh sync.