> For the complete documentation index, see [llms.txt](https://support.whapi.cloud/help-desk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.whapi.cloud/help-desk/users/reserve-and-check-a-whatsapp-account-username.md).

# Reserve and check a WhatsApp account username

Set & Get WhatsApp account username via API

WhatsApp is introducing usernames, allowing users to be found by `@username` instead of relying only on phone numbers.

This improves privacy and gives personal accounts, creators, and brands a more recognizable identity inside WhatsApp.

For more context, see: [WhatsApp usernames and BSUID](https://support.whapi.cloud/help-desk/faq/whatsapp-usernames-and-bsuid)

{% hint style="info" %}

### Current status

At the moment, this method allows you to **reserve** a WhatsApp username.

We are monitoring WhatsApp updates and will adapt the API if WhatsApp changes the username registration flow or related architecture.
{% endhint %}

### Reserve a username

{% embed url="<https://whapi.readme.io/reference/setusername>" %}

Use the **Set account username** method: `PATCH https://gate.whapi.cloud/users/username`

Example request:

```bash
curl --request PATCH \
  --url https://gate.whapi.cloud/users/username \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <CHANNEL_TOKEN>' \
  --header 'content-type: application/json' \
  --data '{
    "reserve": true,
    "username": "coolnickname"
  }'
```

### Request body

* `reserve` — set to `true` to reserve the username.
* `username` — the username you want to reserve for the connected WhatsApp account.

### Check the current username

{% embed url="<https://whapi.readme.io/reference/getusername>" %}

Use the **Get account username** method: `GET https://gate.whapi.cloud/users/username`

This method shows the username state for the WhatsApp account connected to your Whapi.Cloud channel.

For [partners](/help-desk/partner-documentation/partner-program-guidelines/workflow-step-by-step.md), it can also be used to check the username state of a customer’s connected number.

Example request:

```bash
curl --request GET \
  --url https://gate.whapi.cloud/users/username \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <CHANNEL_TOKEN>'
```

### Example response

```json
{
  "username": "whapiassistente",
  "state": "RESERVED",
  "pin": null
}
```

### Response fields

* `username` — the username reserved or assigned to the connected WhatsApp account.
* `state` — the current username state. For example, `RESERVED`.
* `pin` — reserved for additional username-related verification data if required by WhatsApp.

### Important notes

* Username availability and behavior depend on WhatsApp.
* Reserving a username does not necessarily mean that username-based messaging is already available for the account.
* If WhatsApp updates the username flow, Whapi.Cloud will adjust the API behavior accordingly.
* Use `GET /users/username` to check the current state after reservation.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.whapi.cloud/help-desk/users/reserve-and-check-a-whatsapp-account-username.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.