Skip to main content

Create Port-In Request

This request creates a port-in request for one or more phone numbers.

post /porting/port_in

Sample​

A sample POST request to create a port-in request:

curl -X POST \
    'https://api.carrierx.com/core/v2/porting/port_in' \
    -H 'Content-Type: application/json' \
    --data-binary '{
        "account_number":"8675309",
        "account_pin":"1234",
        "customer_full_name":"Jane Doe",
        "customer_address1":"123 Main St",
        "customer_city":"Austin",
        "customer_state":"TX",
        "customer_zip":"78701",
        "phonenumbers":["19512623062"],
        "requested_effective_date":"2026-08-01T00:00:00.000Z"
    }' \
    -H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with a serialized copy of the Port-In Request object:

{
    "account_number": "8675309",
    "account_pin": "1234",
    "customer_address1": "123 Main St",
    "customer_address2": "",
    "customer_city": "Austin",
    "customer_company": "",
    "customer_full_name": "Jane Doe",
    "customer_state": "TX",
    "customer_zip": "78701",
    "date_created": "2026-07-01T14:32:00.000Z",
    "date_modified": "2026-07-01T14:32:00.000Z",
    "errors": [],
    "existing_service_provider": null,
    "gaining_service_provider": null,
    "loa": null,
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "phonenumbers": ["19512623062"],
    "port_in_sid": "c7eae0b4-5eda-4964-8998-d514903b4af0",
    "requested_activation_date": null,
    "requested_effective_date": "2026-08-01T00:00:00.000Z",
    "status": "created"
}

A newly created request is always assigned a status of created and is immediately queued for system precheck validation. existing_service_provider is not returned right away — it, along with gaining_service_provider, is derived asynchronously once the system precheck runs. Refer to Port-In Request Status Values for the full lifecycle.

Required Scopes​

To create a Port-In Request object, the partner must have one of the following scopes enabled:

  • porting.manage
  • porting.create

Body Arguments​

JSON representation of the fields and values of the Port-In Request object to be created.

The following fields are required:

  • account_number
  • account_pin
  • customer_address1
  • customer_city
  • customer_full_name
  • customer_state
  • customer_zip
  • phonenumbers
  • requested_effective_date

The following fields are optional:

  • customer_address2
  • customer_company
  • loa

existing_service_provider cannot be set by the partner — it is derived automatically from the phone numbers provided.

Refer to this table to view all fields that appear in the Port-In Request object.