v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Porting Orders

Create a porting order

Creates a new porting order object.

post/porting_orders

Request body

customer_group_referencestring

A customer-specified group reference for customer bookkeeping purposes

customer_referencestring nullable

A customer-specified reference number for customer bookkeeping purposes

phone_numbersstring[] required

The list of +E.164 formatted phone numbers

Example request

{
  "customer_group_reference": "Group-456",
  "customer_reference": "Acct 123abc",
  "phone_numbers": [
    "+13035550000",
    "+13035550001",
    "+13035550002"
  ]
}

Response

Successful response

Example response

{
  "data": [
    {
      "activation_settings": {
        "activation_status": null,
        "fast_port_eligible": true,
        "foc_datetime_actual": null,
        "foc_datetime_requested": null
      },
      "created_at": "2022-03-17T18:01:01Z",
      "customer_group_reference": null,
      "customer_reference": null,
      "description": "FP Telnyx",
      "documents": {
        "invoice": null,
        "loa": null
      },
      "end_user": {
        "admin": {
          "account_number": null,
          "auth_person_name": null,
          "billing_phone_number": null,
          "business_identifier": null,
          "entity_name": null,
          "pin_passcode": null,
          "tax_identifier": null
        },
        "location": {
          "administrative_area": null,
          "country_code": null,
          "extended_address": null,
          "locality": null,
          "postal_code": null,
          "street_address": null
        }
      },
      "id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
      "messaging": {
        "enable_messaging": false,
        "messaging_capable": true,
        "messaging_port_completed": false,
        "messaging_port_status": "not_applicable"
      },
      "misc": null,
      "old_service_provider_ocn": "Unreal Communications",
      "parent_support_key": null,
      "phone_number_configuration": {
        "billing_group_id": null,
        "connection_id": null,
        "emergency_address_id": null,
        "messaging_profile_id": null,
        "tags": []
      },
      "phone_number_type": "local",
      "phone_numbers": [
        {
          "activation_status": "Activate RDY",
          "phone_number": "{e.164 TN}",
          "phone_number_type": "local",
          "portability_status": "confirmed",
          "porting_order_id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
          "porting_order_status": "draft",
          "record_type": "porting_phone_number",
          "requirements_status": "requirement-info-pending",
          "support_key": "sr_10b316"
        }
      ],
      "porting_phone_numbers_count": 1,
      "record_type": "porting_order",
      "requirements": [],
      "requirements_met": false,
      "status": {
        "details": [],
        "value": "draft"
      },
      "support_key": null,
      "updated_at": "2022-03-17T18:01:01Z",
      "user_feedback": {
        "user_comment": null,
        "user_rating": null
      },
      "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
      "webhook_url": null
    }
  ]
}