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.

curl --location --request PATCH '/porting_orders/' \ --header 'Content-Type: application/json' \ --data-raw '{ "activation_settings": { "foc_datetime_requested": "2021-03-19T10:07:15.527Z" }, "customer_reference": "string", "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": { "new_billing_phone_number": "string", "remaining_numbers_action": "keep", "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 }, "webhook_url": "http://example.com" }'

{ "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_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" } }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string <uuid>

required

Porting Order id

Body Params application/json

activation_settings

object

optional

foc_datetime_requested

string <date-time>

optional

ISO 8601 formatted Date/Time requested for the FOC date

Example:

2021-03-19T10:07:15.527Z

customer_reference

string

optional

documents

object (PortingOrderDocuments)

optional

Can be specified directly or via the requirement_group_id parameter.

invoice

string <uuid>

optional

Returned ID of the submitted Invoice via the Documents endpoint

Example:

ce74b771-d23d-4960-81ec-8741b3862146

loa

string <uuid>

optional

Returned ID of the submitted LOA via the Documents endpoint

Example:

64ffb720-04c7-455b-92d6-20fcca92e935

end_user

object (PortingOrderEndUser)

optional

admin

object (PortingOrderEndUserAdmin)

optional

location

object (PortingOrderEndUserLocation)

optional

messaging

object

optional

enable_messaging

boolean

optional

Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider.

Example:

true

misc

object (PortingOrderMisc)

optional

new_billing_phone_number

string

optional

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.

remaining_numbers_action

enum<string>

optional

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'.

Allowed values:

keepdisconnect

Example:

disconnect

type

enum<string>

optional

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

Allowed values:

fullpartial

Example:

full

phone_number_configuration

object (PortingOrderPhoneNumberConfiguration)

optional

billing_group_id

string

optional

identifies the billing group to set on the numbers when ported

Example:

f1486bae-f067-460c-ad43-73a92848f902

connection_id

string

optional

identifies the connection to set on the numbers when ported

Example:

f1486bae-f067-460c-ad43-73a92848f902

emergency_address_id

string

optional

identifies the emergency address to set on the numbers when ported

Example:

f1486bae-f067-460c-ad43-73a92848f902

messaging_profile_id

string

optional

identifies the messaging profile to set on the numbers when ported

Example:

f1486bae-f067-460c-ad43-73a92848f901

Request

Responses