Number (DID) Porting API Changes - September 30, 2022

New Porting Process API Changes

Upload numbers (choose one of the following):


   Body (post request body as application/json)

"properties": {

"dids": { "type": "array", "items": { "type":

"string" }, "example": ["9198002000"] }


EXAMPLE (in body of request):


"dids": ["1","2","3","4"]


The above endpoint takes a list of DIDs sent as an array in a POST - application/json body and creates a port with those numbers.


    Body (post request body as multipart/formdata)

"properties": {

"file": { "type": "object" }


This file needs to be a CSV formatted as either of the below examples and sent in the body with the key file as a

binary file.







The above endpoint takes a file and creates a port with those numbers

3. Both endpoints above respond with a key orderIds which is an array of orders created from your port. The reason why you would get

multiple orderIds back is that the port in splits orders by carrier. If you have some numbers which go to one carrier and some numberswhich go to another carrier, those orders will be split.

orderIds: { type: 'array', items: { type: 'number' }, example: [1,

2] },

Choose carrier (has been removed from the flow for API only customers)

Previously, you had to choose which carrier your port was going to. This is being handled internally in the first endpoint, so you SKIP using


Get Port In Pricing Information

- Generate costs and get port in details to use in confirm:


- This endpoint is a replacement for this endpoint -

Confirm Port In

- Send confirmation details, request FOC date, and confirm port submission


- This endpoint is a replacement for this endpoint -

Get confirmation details for single port

- Get information about a single endpoint


- This is a replacement for this endpoint -

Misc endpoints

- Upload LOA or Bill as file for toll free port

POST /account/:account_id/port-in/:portin_process_id/upload/files/:type where type is loa or bill

- This is a replacement for this endpoint -

- Add internal note for your port

POST /account/:account_id/port-in/:portin_process_id/tag


The only main change to the process is the first endpoint and well as the structure/declaration of the endpoint URLs. The endpoints which are replacements for existing URLs (as denoted by a thinQ API documentation link) behave exactly the same as they did. inbound/port-in/upload/text or inbound/port-in/upload/text does both the upload and “choose carrier” steps. Additionally, the first endpoint can return multiple order IDs. This means you will have to complete the remaining steps for each order ID returned.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Powered by Zendesk