Ricky logorickyDocs

Request a display name change

POST
/whatsapp-numbers/{channel_id}/display-name

Asks Meta to review a new display name for the number. The name changes only if Meta approves it; then verified_name and name_status change.

Scope: conversations:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Path Parameters

channel_id*string

Channel ID.

Formatuuid

Header Parameters

Idempotency-Key?string

Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as order-10482-ready. Retrying with the same key and body replays the first response instead of repeating the write.

Length8 <= length <= 200

Request Body

application/json
  1. body

A new display name for Meta to review.

display_name*string

The business name to show on the number. Meta reviews it against its rules.

Length1 <= length <= 256

Response Body

Accepted.

application/json
  1. response
data*

A display name change Meta is reviewing.

curl -X POST 'https://getricky.ai/api/v1/whatsapp-numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08/display-name' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "Casa Nativa Óptica"}'
{  "data": {    "requested_display_name": "Casa Nativa Óptica",    "status": "pending_review"  }}