Verifies the portability of a list of phone numbers.
Example request body
{
"phone_numbers": [
{
"phone_number": "+13125354200"
},
{
"phone_number": "+13125354500"
}
]
}
Portability check response
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "phone_numbers": [
- {
- "phone_number": "string"
}
]
}
[- {
- "phone_numbers": [
- {
- "raw_number": "string",
- "e164_number": "string",
- "portable": true,
- "portability_status": "pending",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "non_portable_reason": "invalid_phone_number"
}
]
}
]
Returns a list of your port requests.
page | integer Default: 1 Page number of results to load |
per_page | integer Default: 20 Number of results per page |
search | string Filter results by support_key (pr_*) or partial phone number |
status | string Filter results by status |
include_phone_numbers | boolean Default: true Include phone number objects in the results |
include_sub_requests | boolean Default: false Include sub request objects in the results |
Port Requests Response
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
support_key required | string Key to reference when contacting Telnyx support |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at | string ISO 8601 formatted date indicating when the resource was updated. |
required | Array of objects (PhoneNumberCountAndStatus) |
Array of objects (SubRequest) |
Unauthorized
[- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "support_key": "string",
- "created_at": "string",
- "updated_at": "string",
- "phone_number_counts_by_status": [
- {
- "status": "unassigned",
- "count": 0
}
], - "sub_requests": [
- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
]
}
]
Retrieves the details of an existing port request.
Port Request Response
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
support_key required | string Key to reference when contacting Telnyx support |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at | string ISO 8601 formatted date indicating when the resource was updated. |
required | Array of objects (PhoneNumberCountAndStatus) |
Array of objects (SubRequest) |
Unauthorized
Resource not found
Unprocessable entity. Check message field in response for details.
{- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "support_key": "string",
- "created_at": "string",
- "updated_at": "string",
- "phone_number_counts_by_status": [
- {
- "status": "unassigned",
- "count": 0
}
], - "sub_requests": [
- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
]
}
Returns a list of sub requests for a port request.
Sub Requests Response
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
foc_date required | string ISO 8601 formatted Date/Time of the FOC date |
status required | string Status of sub request |
support_key required | string Key to reference when contacting Telnyx support |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at required | string ISO 8601 formatted date indicating when the resource was updated. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | 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. |
Unauthorized
[- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
]
Retrieves the details of an existing sub request.
Sub Requests Response
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
foc_date required | string ISO 8601 formatted Date/Time of the FOC date |
status required | string Status of sub request |
support_key required | string Key to reference when contacting Telnyx support |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at required | string ISO 8601 formatted date indicating when the resource was updated. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | 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. |
Unauthorized
[- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
]
Edits the details of an existing sub request.
Updated sub request details
foc_date_requested_by_user required | string 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 required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
object (PortingOptionRequest) | |
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 |
Sub Requests Response
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
foc_date required | string ISO 8601 formatted Date/Time of the FOC date |
status required | string Status of sub request |
support_key required | string Key to reference when contacting Telnyx support |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at required | string ISO 8601 formatted date indicating when the resource was updated. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | 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. |
Unauthorized
{- "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "default_connection_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
[- {
- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
]
Returns a list of allowed FOC dates for a sub request.
Allowed FOC dates
Unauthorized
Unprocessable entity. Check message field in response for details.
[- {
- "start": "string",
- "end": "string"
}
]
Request the cancellation of a sub request.
Sub Request Updated
id required | string |
Array of objects (PortRequestPhoneNumber) Phone numbers associated with this port request | |
foc_date required | string ISO 8601 formatted Date/Time of the FOC date |
status required | string Status of sub request |
support_key required | string Key to reference when contacting Telnyx support |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
updated_at required | string ISO 8601 formatted date indicating when the resource was updated. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | 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. |
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "id": "string",
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "sub_request_status": "string",
- "portability_status": "pending"
}
], - "foc_date": "string",
- "status": "unassigned",
- "support_key": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "foc_date_requested_by_user": "string",
- "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "updated_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string",
- "customer_rating": 0,
- "customer_rating_comment": "string"
}
Returns a list of comments for a port request.
Comments Response
Unauthorized
[- {
- "id": "string",
- "body": "string",
- "sub_request_id": null,
- "user_id": "string",
- "created_at": "string"
}
]
Creates a comment on a port request.
Comment Response
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "body": "string",
- "sub_request_id": null
}
{- "id": "string",
- "body": "string",
- "sub_request_id": null,
- "user_id": "string",
- "created_at": "string"
}
Returns a list of supporting documents for a port request.
Supporting Document Responses
Unauthorized
[- {
- "id": "string",
- "body": "string",
- "document_type": "loa",
- "created_at": "string"
}
]
Retrieves the details of an existing supporting document.
Supporting Document Response
Unauthorized
{- "id": "string",
- "body": "string",
- "document_type": "loa",
- "created_at": "string"
}
Creates a link that allows the supporting document to be downloaded. The link expires 1 hour after creation.
{- "url": "string"
}
Returns a list of your draft port requests.
page | integer Default: 1 Page number of results to load |
per_page | integer Default: 20 Number of results per page |
search | string Filter results by partial phone number |
status | string Filter results by status |
include_phone_numbers | boolean Default: true Include phone number objects in the results |
include_sub_requests | boolean Default: false Include sub request objects in the results |
Draft Port Requests Response
id required | string |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
status required | string Draft port request status |
phone_number_count required | integer Count of phone numbers associated with this draft port request |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this draft port request | |
Array of objects (DraftSubRequest) | |
port_request_id required | string ID the associated Port Request. This field is filled if the draft port request has been submitted. |
Unauthorized
Unprocessable entity. Check message field in response for details.
[- {
- "id": "string",
- "created_at": "string",
- "status": "pending",
- "phone_number_count": 0,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "sub_requests": [
- {
- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
], - "port_request_id": "string"
}
]
Creates a new draft port request object.
Draft port request response
id required | string |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
status required | string Draft port request status |
phone_number_count required | integer Count of phone numbers associated with this draft port request |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this draft port request | |
Array of objects (DraftSubRequest) | |
port_request_id required | string ID the associated Port Request. This field is filled if the draft port request has been submitted. |
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "phone_numbers": [
- {
- "phone_number": "string"
}
]
}
{- "id": "string",
- "created_at": "string",
- "status": "pending",
- "phone_number_count": 0,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "sub_requests": [
- {
- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
], - "port_request_id": "string"
}
Retrieves the details of an existing draft port request.
Draft Port Request Response
id required | string |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
status required | string Draft port request status |
phone_number_count required | integer Count of phone numbers associated with this draft port request |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this draft port request | |
Array of objects (DraftSubRequest) | |
port_request_id required | string ID the associated Port Request. This field is filled if the draft port request has been submitted. |
Unauthorized
Resource not found
Unprocessable entity. Check message field in response for details.
{- "id": "string",
- "created_at": "string",
- "status": "pending",
- "phone_number_count": 0,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "sub_requests": [
- {
- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
], - "port_request_id": "string"
}
Submits a draft port request. Once all of the sub requests belonging to a draft port request are populated with required information the draft port request can be submitted, initiating the porting process. Once successfully submitted changes can no longer be made to the draft port request. This request does not require a request body.
Draft port request response
id required | string |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
status required | string Draft port request status |
phone_number_count required | integer Count of phone numbers associated with this draft port request |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this draft port request | |
Array of objects (DraftSubRequest) | |
port_request_id required | string ID the associated Port Request. This field is filled if the draft port request has been submitted. |
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "id": "string",
- "created_at": "string",
- "status": "pending",
- "phone_number_count": 0,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "sub_requests": [
- {
- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
], - "port_request_id": "string"
}
Returns a list of sub requests for a draft port request.
Sub requests
id required | string |
complete required | boolean True if object contains all necessary information, otherwise false |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this sub request | |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | string European business identification number. Applicable only in the European Union |
Unauthorized
Unprocessable entity. Check message field in response for details.
[- {
- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
]
Retrieves the details of an existing draft sub request.
Sub request
id required | string |
complete required | boolean True if object contains all necessary information, otherwise false |
Array of objects (DraftPortRequestPhoneNumber) Phone numbers associated with this sub request | |
foc_date_requested_by_user required | string ISO 8601 formatted Date/Time requested for the FOC date |
phone_number_count required | integer Number of phone numbers attached to this sub request |
underlying_carrier_names | Array of strings Names of underlying carriers for phone numbers on this sub request |
person_or_company_name required | string Person Name or Company name requesting the port |
auth_person_name required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address required | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
created_at required | string ISO 8601 formatted date indicating when the resource was created. |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
required | object (PortingOption) |
pin_passcode required | string PIN/passcode for accounts that have wireless type numbers |
account_number required | string The authorized person's account number with the current service provider |
description required | string Description of draft sub request |
tax_identifier required | string European tax identification number. Applicable only in the European Union |
business_identifier required | string European business identification number. Applicable only in the European Union |
Unauthorized
Unprocessable entity. Check message field in response for details.
{- "id": "string",
- "complete": true,
- "phone_numbers": [
- {
- "phone_number": "string",
- "svtype": "string",
- "carrier_name": "string",
- "coverage_category": "nanp_generic",
- "sub_request_id": "string",
- "portability_status": "pending"
}
], - "foc_date_requested_by_user": "string",
- "phone_number_count": 0,
- "underlying_carrier_names": [
- "string"
], - "person_or_company_name": "string",
- "auth_person_name": "string",
- "billing_phone_number": "string",
- "street_address": "string",
- "extended_address": "string",
- "locality": "string",
- "administrative_area": "string",
- "postal_code": "string",
- "country_code": "string",
- "created_at": "string",
- "default_connection_id": "string",
- "default_message_profile_id": "string",
- "porting_option": {
- "type": "partial",
- "remaining_numbers_action": "keep",
- "new_billing_phone_number": "string"
}, - "pin_passcode": "string",
- "account_number": "string",
- "description": "string",
- "tax_identifier": "string",
- "business_identifier": "string"
}
Updates the specified draft sub request with the values of the parameters passed. Any parameters not included in the request will be left unchanged.
Note: this is where you can set a default connection to pre-configure the numbers on a sub request. Connections can be created using the create connections endpoint
Updated sub request details
foc_date_requested_by_user required | string 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 required | string Name of person authorizing the port request |
billing_phone_number required | string Billing phone number associated with these phone numbers |
street_address required | string First line of billing address |
extended_address | string Second line of billing address |
locality required | string City of billing address |
administrative_area required | string Two character state abbreviation of billing address |
postal_code required | string Postal Code of billing address |
country_code required | string ISO3166-1 alpha-2 country code of billing address |
default_connection_id required | string Identifies the connection to set on the numbers when the port completes |
default_message_profile_id required | string Identifies the messaging profile to set on the numbers when the port completes |
object (PortingOptionRequest) | |
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 |