v1

latestOpenAPI 3.0.02026-07-249301.3 MB

Messaging

Synchronize a conversation from its beginning

This route can be used both to initiate a synchronization process and to monitor its status via regular polling.

get/api/v1/chats/{chat_id}/sync

Path parameters

chat_idstring required

The id of the chat to be synced.

Response

OK. Request succeeded.

object'ChatHistorySync' required

chat_idstring required

A unique identifier.

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

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