Start a port-in request

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "<string>",
    "numbers": [
      {
        "id": "<string>",
        "e164": "<string>",
        "status": "<string>",
        "carrierName": "<string>",
        "portable": true,
        "notPortableReason": "<string>",
        "portOrderId": "<string>",
        "preassignAgentId": "<string>",
        "landedDidId": "<string>",
        "landedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "orders": [
      {
        "id": "<string>",
        "focDate": "2023-11-07T05:31:56Z",
        "supportKey": "<string>",
        "carrierName": "<string>",
        "actionNeeded": [
          {
            "code": "<string>",
            "message": "<string>",
            "fixField": "<string>"
          }
        ]
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "focDate": "2023-11-07T05:31:56Z",
    "signedAt": "2023-11-07T05:31:56Z",
    "lastError": "<string>",
    "comments": [
      {
        "body": "<string>",
        "author": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "entityName": "<string>",
    "authPersonName": "<string>",
    "accountNumber": "<string>",
    "btn": "<string>",
    "streetAddress": "<string>",
    "extendedAddress": "<string>",
    "locality": "<string>",
    "administrativeArea": "<string>",
    "postalCode": "<string>",
    "newBillingPhoneNumber": "<string>",
    "losingCarrier": "<string>",
    "billFileId": "<string>",
    "e911SameAsService": true,
    "e911Street": "<string>",
    "e911Extended": "<string>",
    "e911Locality": "<string>",
    "e911AdministrativeArea": "<string>",
    "e911PostalCode": "<string>",
    "focRequestedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

POST

numbers

port

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "<string>",
    "numbers": [
      {
        "id": "<string>",
        "e164": "<string>",
        "status": "<string>",
        "carrierName": "<string>",
        "portable": true,
        "notPortableReason": "<string>",
        "portOrderId": "<string>",
        "preassignAgentId": "<string>",
        "landedDidId": "<string>",
        "landedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "orders": [
      {
        "id": "<string>",
        "focDate": "2023-11-07T05:31:56Z",
        "supportKey": "<string>",
        "carrierName": "<string>",
        "actionNeeded": [
          {
            "code": "<string>",
            "message": "<string>",
            "fixField": "<string>"
          }
        ]
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "focDate": "2023-11-07T05:31:56Z",
    "signedAt": "2023-11-07T05:31:56Z",
    "lastError": "<string>",
    "comments": [
      {
        "body": "<string>",
        "author": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "entityName": "<string>",
    "authPersonName": "<string>",
    "accountNumber": "<string>",
    "btn": "<string>",
    "streetAddress": "<string>",
    "extendedAddress": "<string>",
    "locality": "<string>",
    "administrativeArea": "<string>",
    "postalCode": "<string>",
    "newBillingPhoneNumber": "<string>",
    "losingCarrier": "<string>",
    "billFileId": "<string>",
    "e911SameAsService": true,
    "e911Street": "<string>",
    "e911Extended": "<string>",
    "e911Locality": "<string>",
    "e911AdministrativeArea": "<string>",
    "e911PostalCode": "<string>",
    "focRequestedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json

The tenant-editable account holder, service address, E911, and port-type fields. Shared by the create and update requests and echoed (minus pinPasscode) on the request detail. All optional at the wire — completeness is enforced at submit.

phoneNumbers

object[]

required

Show child attributes

accountHolderType

enum<string>

Available options:

business,

individual

entityName

string

The person/company on the current-carrier account.

authPersonName

string

The person authorizing the port (the LOA signer).

accountNumber

string

The account number with the current carrier.

btn

string

The billing telephone number on the account.

streetAddress

string

extendedAddress

string

locality

string

City.

administrativeArea

string

State/province.

postalCode

string

countryCode

enum<string>

ISO 3166-1 alpha-2 (US or CA in this release).

Available options:

US,

CA

portType

enum<string>

Available options:

full,

partial

remainingNumbersAction

enum<string>

For a partial port — what to do with the numbers left behind.

Available options:

keep,

disconnect

newBillingPhoneNumber

string

Required when remainingNumbersAction is keep.

losingCarrier

string

billFileId

string

Object key of the uploaded recent bill/invoice.

e911SameAsService

boolean

When true the service address is the registered emergency address (the e911* fields are ignored).

e911Street

string

e911Extended

string

e911Locality

string

e911AdministrativeArea

string

e911PostalCode

string

focRequestedAt

string<date-time>

Requested port date/time (ISO-8601). Omit for the earliest available.

pinPasscode

string

The carrier port-out PIN (required when any number is mobile). Write-only — never returned.

Response

The created draft request.

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes

List port-in requests Get a port-in request

Using the API

Endpoints

Start a port-in request

Authorizations

Body

Response