Edit a porting order
PATCH/porting_orders/:id
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.
Request
Path Parameters
Porting Order id
- application/json
Body
required
Array [
]
misc
object
Possible values: [full
, partial
]
A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.
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 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.
end_user
object
admin
object
Person Name or Company name requesting the port
Name of person authorizing the porting order
Billing phone number associated with these phone numbers
The authorized person's account number with the current service provider
European tax identification number. Applicable only in the European Union
PIN/passcode possibly required by the old service provider for extra verification
European business identification number. Applicable only in the European Union
location
object
First line of billing address
Second line of billing address
City or municipality of billing address
State, province, or similar of billing address
Postal Code of billing address
ISO3166-1 alpha-2 country code of billing address
documents
object
Returned ID of the submitted LOA via the Documents endpoint
Returned ID of the submitted Invoice via the Documents endpoint
activation_settings
object
ISO 8601 formatted Date/Time requested for the FOC date
phone_number_configuration
object
identifies the billing group to set on the numbers when ported
identifies the connection to set on the numbers when ported
identifies the messaging profile to set on the numbers when ported
identifies the emergency address to set on the numbers when ported
requirements
object[]
List of requirements for porting numbers.
identifies the document that satisfies this requirement
Identifies the requirement type that meets this requirement
List of requirements for porting numbers.
user_feedback
object
Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience
A comment related to the customer rating.
Responses
200: Successful response
- application/json
401: Unauthorized
422: Unprocessable entity. Check message field in response for details.