Skip to main content
PATCH
/
v1
/
phone-number
/
{id}
Update Phone Number
curl --request PATCH \
  --url https://api.nedzo.ai/v1/phone-number/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "price": 123,
  "purchase_date": "2023-12-25",
  "renewal_date": "2023-12-25",
  "status": "Active",
  "type": "Inbound and Outbound"
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "phone_number": {
      "number": "<string>",
      "status": "Active",
      "type": "Inbound and Outbound",
      "price": 123,
      "purchase_date": "2023-12-25",
      "renewal_date": "2023-12-25",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_available": true,
      "dials_today": 123,
      "dials_total": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
price
number | null

The price paid for purchasing this phone number.

​
purchase_date
string<date> | null

The date when the phone number was originally purchased.

​
renewal_date
string<date> | null

The date when the phone number is due for renewal.

​
status
enum<string> | null

The current status of the phone number. Phone number status enum

Available options:
Active,
Pending,
Payment Failed,
Activation Failed
​
type
enum<string> | null

Indicates whether the phone number is used for outbound only or both directions. Phone number direction enum

Available options:
Inbound and Outbound,
Outbound Only

Response

Successful Response

​
status_code
integer
required
​
message
string
required
​
data
object | null