Skip to main content

Edit a porting order


Edits the details of an existing porting order.

Any or all of a porting orders attributes may be included in the resource object included in a PATCH request.

If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value.


Path Parameters

    id uuidrequired

    Porting Order id





    type PortingOrderType (string)

    Possible values: [full, partial]

    A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.

    remaining_numbers_action string

    Possible values: [keep, disconnect]

    Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.

    new_billing_phone_number string

    New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.





    entity_name string

    Person Name or Company name requesting the port

    auth_person_name string

    Name of person authorizing the porting order

    billing_phone_number string

    Billing phone number associated with these phone numbers

    account_number string

    The authorized person's account number with the current service provider

    tax_identifier string

    European tax identification number. Applicable only in the European Union

    pin_passcode string

    PIN/passcode possibly required by the old service provider for extra verification

    business_identifier string

    European business identification number. Applicable only in the European Union



    street_address string

    First line of billing address

    extended_address string

    Second line of billing address

    locality string

    City or municipality of billing address

    administrative_area string

    State, province, or similar of billing address

    postal_code string

    Postal Code of billing address

    country_code string

    ISO3166-1 alpha-2 country code of billing address



    loa uuid

    Returned ID of the submitted LOA via the Documents endpoint

    invoice uuid

    Returned ID of the submitted Invoice via the Documents endpoint



    foc_datetime_requested date-time

    ISO 8601 formatted Date/Time requested for the FOC date



    billing_group_id string

    identifies the billing group to set on the numbers when ported

    connection_id string

    identifies the connection to set on the numbers when ported

    messaging_profile_id string

    identifies the messaging profile to set on the numbers when ported

    emergency_address_id string

    identifies the emergency address to set on the numbers when ported

    tags string[]



    List of requirements for porting numbers.

  • Array [

  • field_value stringrequired

    identifies the document that satisfies this requirement

    requirement_type_id stringrequired

    Identifies the requirement type that meets this requirement

  • ]

  • List of requirements for porting numbers.



    user_rating integer

    Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience

    user_comment string

    A comment related to the customer rating.

    webhook_url uri
    customer_reference string


200: Successful response

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.