Ricky logorickyDocs

Update a WhatsApp number

PATCH
/whatsapp-numbers/{channel_id}

Turns calls to the number on or off at Meta. Ricky reads the number back from Meta and answers it as Meta confirms it.

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

The settings of the number that Ricky changes at Meta.

calls_enabled*boolean

Whether customers can call the number and reach the AI agent.

Response Body

Success.

application/json
  1. response
data*

A WhatsApp number, with its status, quality and messaging limit at Meta.

curl -X PATCH 'https://getricky.ai/api/v1/whatsapp-numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "calls_enabled": true}'
{  "data": {    "id": "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f",    "name": "Casa Nativa",    "phone_number": "+50760001234",    "verified_name": "Casa Nativa",    "phone_number_id": "109876543210987",    "whatsapp_business_account_id": "102030405060708",    "connection_mode": "dedicated",    "status": "CONNECTED",    "disconnected_at": null,    "messaging_health": "available",    "quality_rating": "green",    "messaging_limit": "TIER_1K",    "inbound_processing_enabled": true,    "calls_enabled": true,    "connected_at": "2026-10-14T15:30:00.000Z",    "last_synced_at": "2026-10-14T15:30:00.000Z",    "name_status": "approved",    "business_profile": {      "about": "Óptica en Panamá",      "description": null,      "address": null,      "email": null,      "vertical": "RETAIL",      "websites": [        "https://casanativa.example"      ],      "profile_picture_url": null    }  }}