WhatsApp

Set business username

Changed on

Claim or transfer a WhatsApp Business username for the account.

Username rules: 3-35 characters, letters/digits/period/underscore only, must contain at least one letter, no leading or trailing periods, no consecutive periods, no www prefix, no domain TLD suffix (e.g. .com).

If the desired username is currently held by another account, pass transferAction: "force_transfer" to request a transfer. On failure the API returns a standard error envelope with one of these codes: whatsapp_username_unavailable (already taken and transfer not requested), whatsapp_username_ineligible (account not eligible to claim a username), whatsapp_username_transfer_required (username is held elsewhere; retry with force_transfer), or insufficient_permissions (Meta has not granted username management for this WhatsApp Business Account).

post/v1/whatsapp/business-profile/username

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/whatsapp/business-profile/username
  • Auth: HTTP bearer

Request body

accountIdstring required

WhatsApp account ID

usernamestring required

Desired username. Letters, digits, period, and underscore only. Must contain at least one letter. No leading, trailing, or consecutive periods. No www prefix. No domain TLD suffix.

transferAction'none' | 'force_transfer'

Pass force_transfer to request a transfer if the username is held by another account

Response

Username claimed successfully

successboolean
usernamestring
status'approved' | 'reserved' | 'none'

Changes