# `KapsoEx.WhatsApp.Usernames`
[🔗](https://github.com/rocket4ce/kapso_ex/blob/v0.1.0/lib/kapso_ex/whatsapp/usernames.ex#L1)

[Business usernames](https://docs.kapso.ai/docs/whatsapp/business-usernames)
for a phone number.

# `result`

```elixir
@type result() :: {:ok, map()} | {:error, KapsoEx.Error.t()}
```

# `delete`

```elixir
@spec delete(KapsoEx.Client.t(), String.t()) :: result()
```

Deletes the username.

# `get`

```elixir
@spec get(KapsoEx.Client.t(), String.t()) :: result()
```

Gets the current username and its status (`"approved"` or `"reserved"`).

# `set`

```elixir
@spec set(KapsoEx.Client.t(), String.t(), String.t(), keyword()) :: result()
```

Claims or changes the username.

## Options

  * `:transfer_action` - `"none"` (default) or `"force_transfer"` to take
    a username already used by another number in the same portfolio.

# `suggestions`

```elixir
@spec suggestions(KapsoEx.Client.t(), String.t()) :: result()
```

Gets reserved username suggestions.

---

*Consult [api-reference.md](api-reference.md) for complete listing*