Update phone number

PATCH

phone-numbers

{phoneNumberId}

curl --request PATCH \
  --url https://api.zavu.dev/v1/phone-numbers/{phoneNumberId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support Line"
}
'

{
  "phoneNumber": {
    "id": "<string>",
    "phoneNumber": "+15551234567",
    "capabilities": [
      "sms",
      "voice"
    ],
    "status": "active",
    "pricing": {
      "monthlyPrice": 123,
      "upfrontCost": 123,
      "monthlyCost": 123,
      "isFreeNumber": true
    },
    "regulatoryStatus": "approved",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "senderId": "<string>",
    "nextRenewalDate": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

phoneNumberId

string

required

Body

application/json

name

string | null

Custom name for the phone number. Set to null to clear.

Maximum string length: 100

senderId

string | null

Sender ID to assign the phone number to. Set to null to unassign. A number under regulatory review is recorded now and connected to the sender when approved; a rejected number is refused.

Response

Phone number updated.

phoneNumber

object

required

Show child attributes

⌘I

curl --request PATCH \
  --url https://api.zavu.dev/v1/phone-numbers/{phoneNumberId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support Line"
}
'

{
  "phoneNumber": {
    "id": "<string>",
    "phoneNumber": "+15551234567",
    "capabilities": [
      "sms",
      "voice"
    ],
    "status": "active",
    "pricing": {
      "monthlyPrice": 123,
      "upfrontCost": 123,
      "monthlyCost": 123,
      "isFreeNumber": true
    },
    "regulatoryStatus": "approved",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "senderId": "<string>",
    "nextRenewalDate": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}