---
title: "Update a port request"
method: PUT
path: "/v2/partition/{partitionId}/account/{accountId}/port/{portId}"
tags: ["Port"]
---

# Update a port request

`PUT /v2/partition/{partitionId}/account/{accountId}/port/{portId}`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}/port/{portId}`
- Auth: API key in header `X-AUTH-TOKEN`

Update a port request.  There are many reasons this can fail, many limitations, and some possible unintended consequences.  <span hidden>Please see <a href="porting2.html#update-port">here</a> for a detailed explanation.</span>

## Path parameters

- `accountId` string, required
- `partitionId` string, required
- `portId` string, required

## Request body

- PortX
  - `id` string
  - `partitionId` string
  - `accountId` string
  - `telephoneNumbers` string[]
  - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED'
  - `sendLoa` boolean
  - `loaSaved` boolean
  - `carrierId` string
  - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER'
  - `customerServiceRecord` CustomerServiceRecordX
    - `id` string
    - `firstName` string
    - `middleInitial` string
    - `lastName` string
    - `businessName` string
    - `streetNumber` string
    - `streetNumberSuffix` string
    - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
    - `streetName` string
    - `streetSuffix` string
    - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
    - `city` string
    - `state` string: A two-letter state abbreviation
    - `country` string: Alianza supports accounts in the USA and Canada.
    - `postalCode` string
    - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER'
    - `unit` string
    - `customerType` 'BUSINESS' | 'RESIDENTIAL'
    - `firstNameSecondary` string
    - `blockCustomerName` boolean
    - `customerName` string
  - `crdDate` string, date-time
  - `billingTelephoneNumber` string
  - `portingWireType` 'Wireless' | 'Wireline'
  - `portingAuthorizedName` string
  - `wirelessAccountNumber` string
  - `wirelessPin` string
  - `focDate` string, date-time
  - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland'
  - `createdDate` string, date-time
  - `completedDate` string, date-time
  - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER'
  - `telecomSettings` TelecomSettingsX
    - `notes` string
    - `currentCarrier` string
    - `currentCarrierName` string
    - `localReseller` string
    - `loaDate` string, date-time
    - `disconnectInternetService` boolean
    - `disconnectTelevisionService` boolean
    - `tnData` object
  - `hotCutPortId` string
  - `portNow` boolean
  - `canAcceptSMS` boolean
  - `smsCallbackUrl` string
  - `smsSettings` SmsSettingsX
    - `smsLoaDocumentVersionId` string
    - `updatedAt` string, date-time
    - `campaignId` string
    - `smsLoa` FileDataBase64X
      - `contentType` string
      - `name` string
      - `contentBase64` string
    - `enableSMS` boolean
    - `createdAt` string, date-time
    - `authorizingPerson` string
    - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED'
    - `smsCarrierId` string
    - `campaignName` string
    - `remoteCampaignId` string
  - `tags` string[]

## Response `200`

Successful operation

- PortX
  - `id` string
  - `partitionId` string
  - `accountId` string
  - `telephoneNumbers` string[]
  - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED'
  - `sendLoa` boolean
  - `loaSaved` boolean
  - `carrierId` string
  - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER'
  - `customerServiceRecord` CustomerServiceRecordX
    - `id` string
    - `firstName` string
    - `middleInitial` string
    - `lastName` string
    - `businessName` string
    - `streetNumber` string
    - `streetNumberSuffix` string
    - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
    - `streetName` string
    - `streetSuffix` string
    - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
    - `city` string
    - `state` string: A two-letter state abbreviation
    - `country` string: Alianza supports accounts in the USA and Canada.
    - `postalCode` string
    - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER'
    - `unit` string
    - `customerType` 'BUSINESS' | 'RESIDENTIAL'
    - `firstNameSecondary` string
    - `blockCustomerName` boolean
    - `customerName` string
  - `crdDate` string, date-time
  - `billingTelephoneNumber` string
  - `portingWireType` 'Wireless' | 'Wireline'
  - `portingAuthorizedName` string
  - `wirelessAccountNumber` string
  - `wirelessPin` string
  - `focDate` string, date-time
  - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland'
  - `createdDate` string, date-time
  - `completedDate` string, date-time
  - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER'
  - `telecomSettings` TelecomSettingsX
    - `notes` string
    - `currentCarrier` string
    - `currentCarrierName` string
    - `localReseller` string
    - `loaDate` string, date-time
    - `disconnectInternetService` boolean
    - `disconnectTelevisionService` boolean
    - `tnData` object
  - `hotCutPortId` string
  - `portNow` boolean
  - `canAcceptSMS` boolean
  - `smsCallbackUrl` string
  - `smsSettings` SmsSettingsX
    - `smsLoaDocumentVersionId` string
    - `updatedAt` string, date-time
    - `campaignId` string
    - `smsLoa` FileDataBase64X
      - `contentType` string
      - `name` string
      - `contentBase64` string
    - `enableSMS` boolean
    - `createdAt` string, date-time
    - `authorizingPerson` string
    - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED'
    - `smsCarrierId` string
    - `campaignName` string
    - `remoteCampaignId` string
  - `tags` string[]

## Other responses

- `400`: Port is in an incompatible or terminal state, Required field missing, field fails validation
- `401`: Unauthorized
- `404`: Port not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/cb514a0728ed?raw)