Skip to main content
POST
/
v1.0
/
numbers
/
status
json
{
  "StatusChange": "activate",
  "PhoneNumbers": [
    "+12016093801",
    "+12016093802"
  ]
}
{
  "OrderId": "JNUOID-9df281cc-82ac-48fc-b8bf-edc0a5547f04",
  "OrderDate": "2025-05-15T18:20:58.5133475Z",
  "OrderStatus": "Complete",
  "ChangeType": "activate",
  "EffectiveDate": "2023-12-31T00:00:00",
  "Numbers": [
    {
      "Number": "+12016093801",
      "QrCode": "https://qrcodeimage.com"
    },
    {
      "Number": "+12016093802",
      "QrCode": "https://qrcodeimage.com"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
StatusChange
enum<string>
required

Type of status change to perform

Available options:
activate,
cancel,
swap,
replace,
park
Example:

"replace"

​
PhoneNumbers
object[]
required

Array of phone numbers to update

​
EffectiveDate
string

Date when status change takes effect (MM/DD/YYYY)

Example:

"12/31/2023"

​
AreaCode
string

Area code for swap/replace (searched first)

Example:

"201"

​
ZipCode
string

Zip code for swap/replace (if area code unavailable)

Example:

"84043"

Response

200 - application/json

Numbers Activate

The response is of type object.