Trigger sync
POST/v1/:phone_number_id/smb_app_data
Triggers the sync of conversation history or the contact list from the WhatsApp Business App into the Cloud API.
Each type (history and smb_app_state_sync) can be triggered once per
integration, and only within 24 hours of Embedded Signup. Get it wrong or
miss the deadline and the customer has to redo onboarding from scratch.
The response is immediate and only confirms scheduling. The data arrives later, through multiple asynchronous webhooks — read the Mirror · Sync section description to learn how to assemble conversations from them.
Request
Responses
- 200
- 401
- 403
- 429
- 502
Meta Cloud API's response, passed through unchanged. The shape depends on the endpoint — see Meta's documentation.
Response Headers
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.
Missing, malformed, unknown or revoked token (authentication), or a suspended
account (tenant_inactive).
The resource does not belong to your account (forbidden), or the path is on the
mirror's block list (forbidden_endpoint), or your API key is limited to some numbers and
the operation covers the whole account (forbidden).
Rate limit exceeded (rate_limit).
Response Headers
Seconds to wait before retrying.
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.
Could not reach Meta (upstream_error), Meta answered with a 5xx (meta_error),
or it took longer than 30 seconds.