Update PortOrder

Update a PortOrder.

Query

status

Parameter to confirm a draft PortOrder. PortOrder can not be edited once confirmed.

Notes

subaccount

Add Subaccount code, if you want to port phone numbers to a particular subaccount.

account_info

Address can be added two ways, either by adding address_1 and address 2 or providing house_number, street_name etc. Address is required added with the either option.

  • company - Company name
  • address_1 - Address line 1
  • address_2 - Address line 1
  • house_prefix - House number prefix like Apt.
  • house_number - House number
  • house_suffix - House suffix
  • pre_directional - Street pre directional
  • street_name - Street name
  • street_suffix - Street suffix
  • post_directional - Street post directional
  • city - City name
  • state - One of the state name from the options. Options only include states from United States and Canada. For International addresses, leave state blank.
  • zip - Zip code
  • country - Value can be - United States or Canada or International

contact_info

  • first_name - First name of the contact
  • middle_initial - Middle initial of the contact
  • last_name - Last name of the contact
  • email - Email address of the contact
  • Phone - Phone number of the contact
  • title - Title of the Authorized user
  • authorized_user - Authorized user's name

current_service

  • service_provider - Current service provider name
  • account_number - Account number from current service provider
  • pin - PIN from current service provider
  • billing_number - Billing number from current service provider

port_settings

  • desired_due_date - Desired due date in YYYY-MM-DD format
  • partial_port - Set this flag for partial port. Default False.
  • wireless - Set this flag if numbers are wireless numbers. Default False.
  • business - Set this flag if numbers are business numbers. Default True.
  • new_btn - New billing telephone number

observers

An array of additional email addresses to receive port order updates.

phone_numbers

An array of phone number objects.

  • phone_number - 10 digit phone number
  • fax - Set this flag if number is a fax number. Default False.

Sample Response

{
  "portorder": {
    "id": "20045551234",
    "status": "foc",
    "port_order_date": "2022-06-07",
    "foc_at": "2022-06-15",
    "subaccount": null,
    "account_info": {
      "company": "FracTEL, LLC",
      "address_1": "122 4th Ave.",
      "address_2": "Ste. 201",
      "house_prefix": "",
      "house_number": "",
      "house_suffix": "",
      "pre_directional": "",
      "street_name": "",
      "street_suffix": "",
      "post_directional": "",
      "city": "Indialantic",
      "state": "FL",
      "zip": "32903",
      "country": "United States"
    },
    "contact_info": {
      "first_name": "John",
      "middle_initial": "",
      "last_name": "Doe",
      "title": "Owner",
      "authorized_user": "John Doe",
      "email": "[email protected]",
      "phone": "3214991000"
    },
    "current_service": {
      "service_provider": "T-mobile",
      "account_number": "12341234",
      "pin": "1234",
      "billing_number": "3214991000"
    },
    "port_settings": {
      "desired_due_date": "2022-06-15",
      "partial_port": false,
      "wireless": false,
      "business": true,
      "new_btn": ""
    },
    "customer_notes": "",
    "observers": "",
    "phone_numbers": [
      {
        "phone_number": "3214991000,
        "fax": false
      }
     ]
  }
}

Response Properties

PropertyTypeDescription
portorderobjectPortOrder

🚧

Only Draft PortOrders can be updated using this API.

Language
Authentication
Header
Click Try It! to start a request and see the response here!