Initiate Contacts/History Synchronization

Initiates one-time synchronization for the app.

  • Use syncType=smb_app_state_sync to initiate contacts synchronization. On success, smb_app_state_sync webhooks are triggered for current contacts and future contact updates.
  • Use syncType=history to initiate message history synchronization. If the business has shared history, history webhooks are triggered.

Important:

  • This step can be performed only once.
  • To perform again, customer must offboard and complete Embedded Signup again.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App identifier

Form Data
string
enum
required

Synchronization mode

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json