Submit a port

Transfer an existing number onto a locked dedicated line. Live customer porting must be enabled, and authorized must be true. Corrected details may be resubmitted after a rejected carrier attempt has been cancelled. An active or completed transfer cannot be duplicated. Carrier credentials are encrypted and never returned. Scope: comms_lines_write. Limits: 3 a day per line and 10 a day per workspace.

post/lines/{e164}/port

Request

Base URL: https://osis.co/api/v1/comms
URL: https://osis.co/api/v1/comms/lines/{e164}/port
Auth: HTTP bearer

Path parameters

e164string required

The dedicated line, in E.164 format and URL-encoded (+ becomes %2B, like %2B16285551212).

Headers

Idempotency-Keystring

Lets you retry without sending twice.

Request body

target_e164string required

The number you're bringing to Comms, in E.164 format. It replaces the locked line's number.

authorizedtrue

Confirm authorization from the account holder. Required to be true for Gather customer ports.

port_idstring

Recommended: current preparation ID from POST /lock or GET /port. A stale ID is rejected with 409.

Example request

{
  "lnp": {
    "porting_pin": "0000",
    "state": "NY",
    "zip": "10001",
    "country": "United States"
  },
  "port_id": "lport_0123456789abcdef"
}

Response

Port submitted

Changes

No recorded changes to this operation across all 1 revision of this API.