Manage WhatsApp phone numbers

What it is

A WhatsApp business phone number is the sender identity customers see in a conversation. Use these APIs to discover registered numbers, configure their business profile, request a display name change, control commerce visibility, and manage phone-specific settings.

Before you begin

Connect the parent WABA to YCloud.
Add the phone number to the WABA.
Store the WABA ID and phone number in E.164 format.
Upload a profile picture to Meta before setting profilePictureUrl.

How it works

List numbers or retrieve one number to inspect its state.
Register a number before using it for messaging.
Update the customer-facing business profile.
Update display name, commerce visibility, or calling settings as needed.
Retrieve the resource again to confirm the current configuration.

Display name changes and some platform settings may require asynchronous Meta processing.

Request

Register a phone number

curl --request POST \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/register \
  --header "X-API-Key: $YCLOUD_API_KEY"

Update the business profile

curl --request PATCH \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/profile \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "about": "Customer support and order updates",
    "address": "100 Market Street",
    "description": "Example Store",
    "email": "support@example.com",
    "vertical": "RETAIL",
    "websites": ["https://example.com"]
  }'

Update commerce visibility

curl --request PATCH \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/whatsappCommerceSettings \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "isCartEnabled": true,
    "isCatalogVisible": true
  }'

Response

Profile and settings operations return the updated resource.

{
  "about": "Customer support and order updates",
  "email": "support@example.com",
  "vertical": "RETAIL",
  "websites": ["https://example.com"]
}

Registration returns the phone number resource. Store its IDs and inspect its registration and quality state before sending.

Configuration areas

Area	Use it for
Profile	About text, address, description, email, vertical, websites, and profile picture.
Display name	Customer-facing sender name submitted for Meta processing.
Commerce	Catalog visibility and shopping cart controls.
Settings	Phone-specific features such as WhatsApp Calling.

Limits and troubleshooting

Profile fields have format and length limits; use the API Reference for the complete constraints.
Website URLs must include http:// or https://.
A display name update may not become active immediately.
Registration, quality, and WABA state can independently affect sending.
Use the WABA ID and exact E.164 number in every path.

List phone numbers

Discover registered numbers and their parent WABA.

Update profile

Inspect every profile field and constraint.

Getting Started

Guides

Endpoints

Webhooks

Manage WhatsApp phone numbers

What it is

Before you begin

How it works

Request

Register a phone number

Update the business profile

Update commerce visibility

Response

Configuration areas

Limits and troubleshooting

List phone numbers

Update profile

​What it is

​Before you begin

​How it works

​Request

​Register a phone number

​Update the business profile

​Update commerce visibility

​Response

​Configuration areas

​Limits and troubleshooting

List phone numbers

Update profile

What it is

Before you begin

How it works

Request

Register a phone number

Update the business profile

Update commerce visibility

Response

Configuration areas

Limits and troubleshooting