number-requests-v2

Submit complete request details with explicit matching business confirmation

post/v2/number-requests

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/number-requests
  • Auth: API key in header X-Api-Key

Request body

addressCitystring required

City

addressCountrystring required

ISO 3166-1 alpha-2 business country

addressPostalCodestring required

Postal code

addressStatestring

State/province (required for US/CA)

addressStreetstring required

Street

brandNamestring required

Request-owned brand name supplied inline

businessContactEmailstring

Authorized representative email, independent of public support

businessContactFirstNamestring required

Authorized brand contact first name

businessContactLastNamestring required

Authorized brand contact last name

businessDescriptionstring

Business description

companyLegalNamestring required

Registered legal entity name

contactEmailstring required

Brand contact email (domain must match website)

contactPhonestring

Brand support phone

estimatedMonthlyVolumestring

Estimated monthly segment volume

exampleSmsMessagestring

Example messages, one per line; 10DLC sends your first four plus the opt-out confirmation sample, each 20 to 320 characters

identifierTypestring

Type of value in taxId (e.g. ein, cbn, neq, provincial_number, registration_number). Auto-defaulted for countries with one option; required for countries with multiple options.

industrystring

Industry

listNamestring required

Sending list name

messagingTypestring

Messaging use case, e.g. GENERAL_MARKETING, MIXED (default MIXED)

optInFormUrlstring required

Public URL of the customer-hosted opt-in page. Screenshotted at provision time as carrier opt-in proof (replaces the white-label site we normally generate).

phoneNumberTypestring

'toll_free' (default) or '10dlc'. short_code is not supported.

privacyPolicyUrlstring

Privacy policy URL; required for US toll-free submissions. For US 10DLC, optional during the shadow rollout and required when readiness enforcement is enabled.

promotionSummarystring

Summary of the messaging program

targetCountriesstring[] required

Exactly one ISO 3166-1 alpha-2 target country

taxIdstring required

Request-owned carrier registration identifier supplied inline; values are never substituted from another resource

termsConditionsUrlstring

Terms & Conditions URL for the opt-in page; required for US toll-free and 10dlc submissions.

verticalstring

TCR business vertical — required for 10dlc

websiteUrlstring required

Business website URL

Example request

{
  "businessVerification": {
    "relationship": "account_business"
  }
}

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.