KapsoEx.WhatsApp.Usernames (kapso_ex v0.1.0)

Copy Markdown View Source

Business usernames for a phone number.

Summary

Functions

Deletes the username.

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

Claims or changes the username.

Gets reserved username suggestions.

Types

result()

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

Functions

delete(client, phone_number_id)

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

Deletes the username.

get(client, phone_number_id)

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

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

set(client, phone_number_id, username, opts \\ [])

@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(client, phone_number_id)

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

Gets reserved username suggestions.