Submit 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>"
    }
  ]
}

{
  "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>"
    }
  ]
}

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

POST

numbers

port

{id}

submit

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>"
    }
  ]
}

{
  "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>"
    }
  ]
}

{
  "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.

Path Parameters

string

required

Response

The submitted request.

success

boolean

required

data

object

required

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.

Show child attributes

message

string

errors

object[]

Show child attributes

Using the API

Endpoints

Submit a port-in request

Authorizations

Path Parameters

Response