Sign in

v1

latestOpenAPI 3.0.32026-07-268345159.5 KB
Partner Linked Application

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.
post/app/{appId}/coex/sync

Path parameters

appIdstring required

App identifier

Response

Sync request accepted successfully

statusstring required

Example response

{
  "data": {
    "messaging_product": "whatsapp",
    "request_id": "<REQUEST_ID>"
  },
  "status": "success"
}