Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Phone Numbers

Update a phone number business username

Requests a Business Username update for a WhatsApp business phone number. The requested username may require Meta review before it becomes active. If Meta accepts or reserves the request for review, the response status is usually reserved; pending_review is kept only as a legacy compatibility value. If Meta returns an error, YCloud returns the error and does not change the stored Business Username state.

The username value is a plain username without @. YCloud trims leading and trailing whitespace and normalizes the value to lowercase before validation and submission.

patch/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format.

Request body

usernamestring required

Business Username to request for the phone number. Send the plain username without @.

YCloud trims leading and trailing whitespace and normalizes the value to lowercase before validation and submission. The value must be 3-35 characters, contain only English letters, numbers, periods, and underscores, and contain at least one English letter. It must not start or end with a period, contain consecutive periods, start with www, or end with common domain suffixes such as .com, .org, .net, .int, .edu, .gov, .mil, .us, .in, or .html.

Example request

{
  "username": "acme.support"
}

Response

Successfully submitted the update request.

idstring

Phone number ID.

wabaIdstring

WhatsApp Business Account ID.

phoneNumberstring

Phone number in E.164 format.

displayPhoneNumberstring

Display phone number.

businessUsernamestring

Active Business Username. The value is a plain username without @.

businessUsernameStatus'not_set' | 'active' | 'pending_review' | 'reserved'

Business Username state for a WhatsApp business phone number.

  • not_set: No active or pending Business Username exists.
  • active: A Business Username is active.
  • reserved: A requested Business Username is reserved by Meta and may still be under review.
  • pending_review: Legacy compatibility value for an under-review request. New writes use reserved. If an active username exists while a new request is reserved or under review, businessUsernameStatus is reserved, businessUsername contains the still-active username, and requestedBusinessUsername contains the requested username.
requestedBusinessUsernamestring

Last requested Business Username that is still under review. This value can coexist with an active businessUsername while the new request is pending.

businessUsernameUpdatedAtstring date-time

The time when the Business Username state was last updated.

Example response

{
  "id": "1234567890123456",
  "wabaId": "whatsapp-business-account-id",
  "phoneNumber": "+16315551111",
  "displayPhoneNumber": "+1 631-555-1111",
  "businessUsername": "acme.support",
  "requestedBusinessUsername": "acme.help",
  "businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
}