Skip to main content
POST
/
{phone_number_id}
/
username
Claim or change username
curl --request POST \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "username": "kapso_support",
  "transfer_action": "none"
}
'
{
  "status": "reserved"
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Integrations > API keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Body

application/json
​
username
string
required

Desired business username

Example:

"kapso_support"

​
transfer_action
enum<string>
default:none

Use force_transfer to move a username from another phone number in the same business portfolio.

Available options:
none,
force_transfer

Response

Username request accepted

​
status
enum<string>
Available options:
approved,
reserved
Example:

"reserved"