Update a number
Change the nickname, the renewal settings or the price fixed for the customer. Fields you leave out stay as they are.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringapplication/json- body
nickname?|Your own label for the number; null clears it
autoRenew?booleanrenewDuration?stringLength of the rental
"12h""1d""7d""30d""180d""365d"customerPrice?|What the customer pays for one unit of this item from now on, in minor units of their list's currency. It beats their contract and list prices. null clears it
Success
application/json- response
Success
id*stringnumber*stringDigits only, as issued by the carrier
country*stringISO 3166-1 alpha-2 country code, for example US or GB
^[A-Z]{2}$product*stringany_service receives SMS from anyone; single_service is locked to one sender
"any_service""single_service"service*|The one service a single_service number receives from
status*string"active""expired""cancelled"customerId*|The customer this was bought for, if any
orderId*stringnickname*string|nullstartsAt*stringISO 8601 timestamp
date-timeendsAt*stringISO 8601 timestamp
date-timeautoRenew*booleanWhether it is extended shortly before it ends
renewDuration*stringHow long each automatic renewal adds
"12h""1d""7d""30d""180d""365d"unitPrice*integerPrice of one rental period, in minor units
customerPrice*|A price per renewal fixed for the customer on this number alone, in their list's currency. It beats their contract and list. Null when there is none
paidTotal*integerEverything charged for this number so far, in minor units
messageCount*integercreatedAt*stringISO 8601 timestamp
date-timecurl -X PATCH "https://example.com/v1/numbers/num_01K6XJ4Q8ZT3M9R5V2B7WDHNCA" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "num_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "number": "15550100002", "country": "US", "product": "any_service", "service": null, "status": "active", "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "orderId": "ord_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "nickname": "Support line", "startsAt": "2026-10-07T11:04:31.000Z", "endsAt": "2026-11-06T11:04:31.000Z", "autoRenew": true, "renewDuration": "30d", "unitPrice": 1200, "customerPrice": null, "paidTotal": 1200, "messageCount": 3, "createdAt": "2026-10-07T11:04:31.000Z"}