Sync a WhatsApp business account status
Sync a WhatsApp business account status. Request: POST /v1/whatsapp/business-accounts/{accountId}/sync. Scope: whatsappAccounts:read.
POST
Reads the number's quality rating, messaging limit, and registration from Meta, and registers the number with the Cloud API if it is verified but not yet registered.
apiKeyheader
x-api-key<token>accountId*stringMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
id*WhatsAppBusinessAccountIdMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$qualityRating*stringValue in
"green""yellow""red""unknown"messagingLimit*string|nullcurrentLimit*integerRange
0 <= value <= 9007199254740991businessPortfolioId*string|nullverificationStatus*stringValue in
"pending""verified""failed""suspended"syncedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.whatsapp.syncAccountStatus({
"accountId": "example"
});Example Response
{
"id": "string",
"qualityRating": "green",
"messagingLimit": "string",
"currentLimit": 0,
"businessPortfolioId": "string",
"verificationStatus": "pending",
"syncedAt": "string"
}