Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Channels

Update WhatsApp number (profile + agent)

Updates a WhatsApp number's business profile and/or binds it to an agent. Pass agentId to bind, null to unbind, or omit to leave the binding unchanged. Requires a USER API key.

put/public/v1/channels/whatsapp/{integrationId}/numbers/{phoneNumberId}

Path parameters

integrationIdinteger required
Example:12
phoneNumberIdstring required
Example:109876543210123

Request body

descriptionstring nullable
websitestring nullable
secondaryWebsitestring nullable
addressstring nullable
emailstring email nullable
aboutstring nullable
category'AUTO' | 'BEAUTY' | 'APPAREL' | 'EDU' | 'ENTERTAIN' | 'EVENT_PLAN' | 'FINANCE' | 'GROCERY' | 'GOVT' | 'HOTEL' | 'HEALTH' | 'NONPROFIT' | 'PROF_SERVICES' | 'RETAIL' | 'TRAVEL' | 'RESTAURANT' | 'OTHER' | 'UNDEFINED' nullable
agentIdstring nullable

Example request

{
  "description": "example",
  "website": "example",
  "secondaryWebsite": "example",
  "address": "example",
  "email": "user@example.com",
  "about": "example",
  "category": "AUTO",
  "agentId": "asst_123"
}

Response

The updated WhatsApp number

idnumber required
phoneNumberIdstring required
assistantIdstring nullable required
status'CONNECTED' | 'PENDING' | 'UNREGISTERED' | 'ERROR' | 'VERIFICATION_PENDING' | 'DELETED' required
wabaIdstring required
namestring required
aboutstring nullable required
descriptionstring nullable required
addressstring nullable required
category'AUTO' | 'BEAUTY' | 'APPAREL' | 'EDU' | 'ENTERTAIN' | 'EVENT_PLAN' | 'FINANCE' | 'GROCERY' | 'GOVT' | 'HOTEL' | 'HEALTH' | 'NONPROFIT' | 'PROF_SERVICES' | 'RETAIL' | 'TRAVEL' | 'RESTAURANT' | 'OTHER' | 'UNDEFINED' required
displayPhoneNumberstring required
websitestring nullable required
secondaryWebsitestring nullable required
verificationStatus'VERIFIED' | 'NOT_VERIFIED' required
imagestring nullable required
emailstring nullable required
createdAtstring required
updatedAtstring required

Example response

{
  "id": 1,
  "phoneNumberId": "example",
  "assistantId": "example",
  "assistant": {
    "id": "example",
    "name": "example"
  },
  "status": "CONNECTED",
  "wabaId": "example",
  "name": "example",
  "about": "example",
  "description": "example",
  "address": "example",
  "category": "AUTO",
  "displayPhoneNumber": "example",
  "website": "example",
  "secondaryWebsite": "example",
  "verificationStatus": "VERIFIED",
  "image": "example",
  "email": "example",
  "createdAt": "example",
  "updatedAt": "example"
}