Update Port Order Details

If the Port Order is in a ‘Pending’ or ‘Rejected’ status, the user can change the details on the Port Order. This is intended to update fields except phone numbers, LOA and Presets. This is typically used when a port order has been rejected and some of the details must be updated.

Method

PATCH /portorders

Body Parameters

  • data
    object Required

    Port order object to be submitted which is composed of type and attributes.

  • attributes
    object Required

    Object composed of the following attributes of a port order.

  • Attributes

  • loa_details
    object

    Email addresses to send the LOA (Letter of Agency) document to. You can add these details in your port order submission but the email feature is not yet ready and will be implemented in the future.

    • email
      string

      Email address of the primary recipient of the LOA document.

    • cc
      string

      Email address to be copied in the LOA document email.

  • billing_name
    string

    First and last name of the person responsible for e-signing LOAs. For business orders, this person must be authorized to make changes with the Losing Service Provider (LSP).

  • city
    string

    City where the LSP services the porting phone numbers.

  • country
    string

    Country in ISO 3166-1 alpha-2 code format where the LSP services the porting phone numbers. Valid options are US and CA.

  • provider
    string

    Current provider for the porting phone numbers.

  • state
    string

    Two-character US state or Canadian province in ISO 3166-2 format where the service city is located.

  • street
    string

    Street address where the LSP services the porting phone numbers. This is often referred to as the “Service Address” and can be different from the “Billing Address”.

  • street2
    string

    Address line 2, if any. For example, Suite 600.

  • usage_type
    string

    Possible usage types are "Business" and "Residential".

  • zip
    string

    US zip or Canadian postal code where the LSP services the porting phone numbers. For example, 98104 for the US and M4C 5K7 for Canada.

  • alias
    string

    Friendly name to be assigned to the port order.

  • billing_number
    string

    Primary contact phone number on record for your account with the LSP.

  • company
    string

    Company name associated with the porting phone numbers.

  • desired_completion_date
    string

    Desired completion date of the Port Order in UTC following the complete date or complete date plus hours, minutes, seconds and a decimal fraction of a second ISO 8601 format. For example, 2018-06-14 or 2018-06-14T19:19:01.00Z. Note: the date specified must be in the future.

  • enable_cnam_lookups
    string

    Indicates whether CNAM lookups or "dips" for caller ID information on inbound calls will be enabled for the porting phone numbers.

  • last_4_ssn
    string

    The last four digits of the authorized contact's (billing name) Social Security Number. This only applies to wireless porting phone numbers.

  • pin
    string

    PIN number of the account with your LSP that is associated with the porting phone number. This is mandatory for wireless numbers but optional for long code and toll-free numbers.

  • provider_account
    string

    The ID for your account with the LSP.

  • status_url
    string

    URL to send port order notifications to.

Response Format

On success, the HTTP status code in the response header is 200 OK and the body contains the updated version of the port order.

Example Request

							PATCH /v2/portorders/41351 HTTP/1.1
Content-Type: application/json
Accept: application/json

"data": {
  "attributes": {
  },
  "type": "portorder"
}

							
							
						

Success

							200 OK

{
  "data": {
    "attributes": {
      "alias": "Port Order 6/12/2018",
      "billing_address": {
        "city": "Seattle",
        "country": "US",
        "state": "WA",
        "street": "1218 3rd Ave",
        "street2": null,
        "zip": "98101"
      },
      "billing_name": "John Doe",
      "billing_number": "",
      "business_documents": [
        {
          "filename": "https://s3-us-west-2.amazonaws.com/port-order-docs/csr.pdf",
          "status": "uploaded"
        },
        {
          "filename": "https://s3-us-west-2.amazonaws.com/port-order-docs/bill.pdf",
          "status": "failed"
        }
      ],
      "comments": [],
      "company": "Leather Inc.",
      "cost": "7.5",
      "desired_completion_date": "2018-07-12",
      "enable_cnam_lookups": true,
      "group_id": "38697",
      "last_4_ssn": "",
      "loa_details": {
        "cc": "mbermudez+test@flowroute.com",
        "email": "mbermudez@flowroute.com"
      },
      "numbers": [
        "+12065013456"
      ],
      "pin": "4321",
      "presets": {
        "cnam_id": null,
        "e911_id": null,
        "alias": null,
        "failover_route_id": null,
        "primary_route_id": null
      },
      "provider": "Verizon",
      "provider_account": "123ABC",
      "status": "pending",
      "status_updated_at": null,
      "status_url": "https://ycx56aoy9j.execute-api.us-west-2.amazonaws.com/dev/message_to_slack",
      "usage_type": "residential"
    },
    "id": "42361",
    "links": {
      "self": "https://api.flowroute.com/v2/portorders/42361"
    },
    "type": "portorder"
  },
  "links": {
    "self": "https://api.flowroute.com/v2/portorders/42361"
  }
}