Update a WhatsApp business account
Updates the display name or webhook settings of a connected WhatsApp business account.
PATCH
Updates the display name or webhook settings of a connected WhatsApp business account.
apiKeyheader
x-api-key<token>accountId*stringMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
displayName?|nullwebhookUrl?string|null|nullSuccess
application/json- response
id*WhatsAppBusinessAccountIdMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$organizationId*stringnamespaceId*|nullphoneNumber*stringphoneNumberId*stringdisplayName*stringwhatsappBusinessAccountId*stringverificationStatus*stringValue in
"pending""verified""failed""suspended"credentialStatus*stringValue in
"active""reconnect_required"tokenExpiresAt*string|nullisDefault*booleanwebhookUrl*string|nullqualityRating*stringValue in
"green""yellow""red""unknown"messagingLimit*string|nullcurrentLimit*integerRange
0 <= value <= 9007199254740991businessPortfolioId*string|nullbusinessAppConnectedAt*string|nullbusinessAppDisconnectedAt*string|nullbusinessAppDisconnectReason*|nullcontactsSyncRequestedAt*string|nullhistorySyncStatus*|nullhistorySyncProgress*|nullisActive*booleancreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.whatsapp.updateBusinessAccount({
"accountId": "example"
});Example Response
{
"id": "string",
"organizationId": "string",
"namespaceId": "string",
"phoneNumber": "string",
"phoneNumberId": "string",
"displayName": "string",
"whatsappBusinessAccountId": "string",
"verificationStatus": "pending",
"credentialStatus": "active",
"tokenExpiresAt": "string",
"isDefault": true,
"webhookUrl": "string",
"qualityRating": "green",
"messagingLimit": "string",
"currentLimit": 0,
"businessPortfolioId": "string",
"businessAppConnectedAt": "string",
"businessAppDisconnectedAt": "string",
"businessAppDisconnectReason": "partnerRemoved",
"contactsSyncRequestedAt": "string",
"historySyncStatus": "requested",
"historySyncProgress": 0,
"isActive": true,
"createdAt": "string",
"updatedAt": "string"
}