Skip to main content

Edit a sub request


Edits the details of an existing sub request.


Path Parameters

    port_request_id stringrequired

    Port Request id

    id stringrequired

    Sub Request id



Updated sub request details

    foc_date_requested_by_user stringrequired

    ISO 8601 formatted Date/Time requested for the FOC date

    person_or_company_name string

    Person Name or Company name requesting the port

    auth_person_name stringrequired

    Name of person authorizing the port request

    billing_phone_number stringrequired

    Billing phone number associated with these phone numbers

    street_address stringrequired

    First line of billing address

    extended_address string

    Second line of billing address

    locality stringrequired

    City of billing address

    administrative_area stringrequired

    Two character state abbreviation of billing address

    postal_code stringrequired

    Postal Code of billing address

    country_code stringrequired

    ISO3166-1 alpha-2 country code of billing address

    default_connection_id stringrequired

    Identifies the connection to set on the numbers when the port completes



    Options for the processing of numbers with your current service provider.

    type stringrequired

    Possible values: [partial, full]

    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 telephone numbers for the remaining numbers. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.

    Options for the processing of numbers with your current service provider.

    pin_passcode string

    PIN/passcode for accounts that have wireless type 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

    business_identifier string

    European business identification number. Applicable only in the European Union

    customer_rating integer

    Once a sub request is ported, cancellation is requested or the sub request is cancelled, the user may rate their experience.

    customer_rating_comment string

    A comment related to the customer rating


200: Sub Requests Response

401: Unauthorized