Skip to main content
POST
/
v1.0
/
numbers
/
status
json
{
"StatusChange": "replace", //options can be 'activate', 'cancel', 'swap', 'replace', 'park', and 'swap-sim'
"EffectiveDate": "12/31/2023",
"AreaCode": "201",  //available for Swap and Replace only
                    //lookup area code first
"ZipCode": "XXXXX", //available for Swap and Replace only : if area code unavailable, then system looks at
                    //Zipcode options you may input both, or just one of the two; however Area Code will
                    // search first if included. If AreaCode and ZipCode are left blank or NULL, a
                    // randomized set of results will be requested.
"PhoneNumbers":
    [
        {
            "Number": "+12016093801",
            "ICCID": "202620160938010123"   //available for swap-sim only (optional)
        },
        {
            "Number": "+12232233180",
            "ICCID": "202620160938010123"   //available for swap-sim only (optional)
        }
    ]
}
{
  "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,
swap-sim,
replace,
park
Example:

"replace"

​
EffectiveDate
string
required

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

Example:

"12/31/2023"

​
PhoneNumbers
object[]
required

Array of phone numbers to update

​
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.