CoEx Event Guide

https://partner-docs.gupshup.io/update/docs/coexistence-events

Description

1. Method/path: POST /app/:appId/coex/sync (optional trailing slash supported).
2. Full URL segment: BASE_URL/partner/app/:appId/coex/sync (context path /partner, controller prefix /app).
3. Auth: Role PARTNER_APP (see Authentication above).
4. Content-Type: application/x-www-form-urlencoded.
5. Rate limit: 10 requests per 60 seconds

Note:

Both smb_app_state_sync and history synchronization can be triggered only once, and must be initiated within 24 hours of onboarding.

Request example

Contacts sync (smb_app_state_sync):

curl --location --request POST '{{BASE_URL}}/partner/app/{{APP_ID}}/coex/sync' \
  --header 'Authorization: Bearer {{PARTNER_APP_TOKEN}}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'syncType=smb_app_state_sync'

Message history sync (history):

curl --location --request POST '{{BASE_URL}}/partner/app/{{APP_ID}}/coex/sync' \
  --header 'Authorization: Bearer {{PARTNER_APP_TOKEN}}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'syncType=history'

Steps to use this API

1. Make the API call with the desired syncType
2. Then you will receive an event from Meta on the webhook as mentioned in the document here

Purpose of Request ID

The request ID is from meta. If you don't receive the respective event after the API call from meta, then this ID can be used to raise the missing event issue with meta.

Response example

Success

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

Sync modes (syncType):

Request parameters

Status codes