UNunipile
Messaging

Synchronize a conversation from its beginning

Changed on

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

Request

Path parameters

chat_idstring required

The Unipile or provider ID of the chat to be synced.

Query parameters

account_idstring

The account ID. Mandatory when chat_id is a provider ID.

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.

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/connection_limit_reached enum value to the response property for the response status

    • warning

      added the new errors/not_supported_by_provider enum value to the response property for the response status

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • info

      added the new optional query request parameter account_id