Skip to main content
POST
Submit a port-in request

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json

Fields required to submit a number port-in request.

numbers
required

A single E.164 number or an array of E.164 numbers to port in.

Minimum array length: 1
currentCarrier
string

Name of the losing carrier the numbers are ported from.

Minimum string length: 1
loaFileUrl
string<uri>

Devotel-issued GCS signed URL of the uploaded LOA PDF (upload via POST /api/v1/files/upload). Omit for manual-mode processing.

country
string

ISO 3166-1 alpha-2 country of the numbers; drives provider selection (US/CA → Telnyx, elsewhere → DIDWW). Omit to store the request without carrier dispatch.

Required string length: 2
contactName
string
contactEmail
string<email>
accountNumber
string
Maximum string length: 100
accountPin
string
Maximum string length: 50
authorizedSigner
string
Maximum string length: 200

Response

201 - application/json

The created port-in request.

data
object

A number port-in request stored for the organization.

meta
object