Porting Orders
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.
patch/porting_orders/{id}
Path parameters
idstring uuid required
Porting Order id
Request body
Example request
{
"activation_settings": {
"foc_datetime_requested": "2021-03-19T10:07:15.527Z"
},
"documents": {
"invoice": "ce74b771-d23d-4960-81ec-8741b3862146",
"loa": "64ffb720-04c7-455b-92d6-20fcca92e935"
},
"end_user": {
"admin": {
"account_number": "123abc",
"auth_person_name": "Porter McPortersen II",
"billing_phone_number": "13035551234",
"business_identifier": "abc123",
"entity_name": "Porter McPortersen",
"pin_passcode": "1234",
"tax_identifier": "1234abcd"
},
"location": {
"administrative_area": "TX",
"country_code": "US",
"extended_address": "14th Floor",
"locality": "Austin",
"postal_code": "78701",
"street_address": "600 Congress Avenue"
}
},
"messaging": {
"enable_messaging": true
},
"misc": {
"remaining_numbers_action": "disconnect",
"type": "full"
},
"phone_number_configuration": {
"billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
"connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
"emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
"messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
"tags": [
"abc",
"123"
]
},
"requirement_group_id": "DE748D99-06FA-4D90-9F9A-F4B62696BADA",
"requirements": [
{
"field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
"requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
}
],
"user_feedback": {
"user_comment": "I loved my experience porting numbers with Telnyx",
"user_rating": 5
}
}Response
Successful response
Example response
{
"data": {
"activation_settings": {
"activation_status": null,
"fast_port_eligible": true,
"foc_datetime_actual": null,
"foc_datetime_requested": "2022-04-08T15:00:00Z"
},
"created_at": "2022-03-24T14:22:28Z",
"customer_group_reference": "Group-789",
"customer_reference": "Test1234",
"description": "FP Telnyx",
"documents": {
"invoice": null,
"loa": null
},
"end_user": {
"admin": {
"account_number": "123abc",
"auth_person_name": "Porter McPortersen II",
"billing_phone_number": "+13035551234",
"business_identifier": "abc123",
"entity_name": "Porter McPortersen",
"pin_passcode": "1234",
"tax_identifier": "1234abcd"
},
"location": {
"administrative_area": "TX",
"country_code": "US",
"extended_address": "14th Floor",
"locality": "Austin",
"postal_code": "78701",
"street_address": "600 Congress Avenue"
}
},
"id": "eef10fb8-f3df-4c67-97c5-e18179723222",
"messaging": {
"enable_messaging": true,
"messaging_capable": true,
"messaging_port_completed": false,
"messaging_port_status": "pending"
},
"misc": {
"new_billing_phone_number": null,
"remaining_numbers_action": null,
"type": "full"
},
"old_service_provider_ocn": "Unreal Communications",
"parent_support_key": null,
"phone_number_configuration": {
"billing_group_id": null,
"connection_id": "1752379429071357070",
"emergency_address_id": null,
"messaging_profile_id": null,
"tags": []
},
"phone_number_type": "local",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"requirements": [],
"requirements_met": false,
"status": {
"details": [],
"value": "draft"
},
"support_key": null,
"updated_at": "2022-03-24T14:26:53Z",
"user_feedback": {
"user_comment": null,
"user_rating": null
},
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
}
}