Purchase a phone number for a specific account.

http
POST https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}/purchase

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
locationIdstringYesve9EPM428h8vShlRW1KTThe unique identifier of the account

Body

NameTypeRequiredExampleDescription
phoneNumberstringYes+18305551234The phone number to purchase
countryCodestringNoUSISO 3166-1 alpha-2 country code of the number
numberTypestringNolocalType of phone number Possible values: 'local', 'tollFree', 'mobile'
addressSidstringNoAD1234567890abcdef1234567890abcdeTwilio address SID for compliance
bundleSidstringNoBU1234567890abcdef1234567890abcdeTwilio bundle SID for regulatory compliance
localitystringNoSan AntonioLocality where the number is being purchased
regionstringNoTXRegion where the number is being purchased
fingerprintIdstringNofp_abc123def456Unique request ID for idempotency (fingerprint of the purchase request)
skipLocationKYCbooleanNoFalseSkip account-level KYC verification if agency-level compliance has already been verified

Responses

201 - Phone number successfully purchased. Returns the updated Twilio account state for the account.
  • id (string, required): Unique identifier of the Twilio account record Example: 8xMPW85D2z5jgcTa5L1p

  • account_sid (string, required): Twilio Account SID Example: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

  • under_ghl_account (boolean, required): Whether this account is under a GHL-managed Twilio account Example: True

  • validate_sms (boolean, required): Whether SMS validation is enabled Example: True

  • location_id (string, required): The account ID this Twilio account belongs to Example: aa4PBpxnPc9bs4LSdiW7

  • migration_status (string): Current migration status of the account Example: completed

  • migration_numbers (string[]): List of numbers being migrated

  • assigned_to_numbers (object): Map of phone numbers to assigned user IDs

  • numbers (object, required): Map of phone numbers to their service type (e.g. 'conversation')

  • number_name (object): Map of phone numbers to their friendly names

  • new_account_sid (string): New account SID if the account has been migrated to new credentials

json
{
  "id": "8xMPW85D2z5jgcTa5L1p",
  "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "under_ghl_account": true,
  "validate_sms": true,
  "location_id": "aa4PBpxnPc9bs4LSdiW7",
  "migration_numbers": [],
  "assigned_to_numbers": {},
  "numbers": {
    "+18705871861": "conversation"
  },
  "number_name": {
    "+18705871861": "My Number"
  },
  "new_account_sid": ""
}
400 - Bad request - Invalid parameters or number unavailable
  • message (string): Example: Phone number is no longer available

  • error (string): Example: Bad Request

  • statusCode (number): Example: 400

json
{
  "message": "Phone number is no longer available",
  "error": "Bad Request",
  "statusCode": 400
}
401 - Unauthorized
json
{}
500 - Internal server error - An unexpected error occurred while purchasing the phone number

Example

curl -X POST 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/purchase' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "phoneNumber": "+18305551234",
  "countryCode": "US",
  "numberType": "local",
  "addressSid": "AD1234567890abcdef1234567890abcde",
  "bundleSid": "BU1234567890abcdef1234567890abcde",
  "locality": "San Antonio",
  "region": "TX",
  "fingerprintId": "fp_abc123def456",
  "skipLocationKYC": false
}'

Last updated October 26, 2026

Was this page helpful?