# `KapsoEx.Platform.DisplayNames`
[🔗](https://github.com/rocket4ce/kapso_ex/blob/v0.1.0/lib/kapso_ex/platform/display_names.ex#L1)

Display name change requests. Meta reviews most changes within 24-48
hours; poll `get/3` to follow the review.

# `result`

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

# `create`

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

Requests a display name change.

# `get`

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

Gets a display name request and its review status.

# `list`

```elixir
@spec list(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()
```

Lists display name requests for a number, most recent first. Params: `page`, `per_page`.

---

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