number-requests-v2

post/v2/number-requests/drafts

Request

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

Request body

addressCitystring

City

addressCountrystring

ISO 3166-1 alpha-2 business country; changing it clears a stale implicit identifier type

addressPostalCodestring

Postal code

addressStatestring

State/province

addressStreetstring

Street

brandNamestring

Brand name

businessContactEmailstring

Authorized representative email, independent of public support

businessContactFirstNamestring

Authorized brand contact first name

businessContactLastNamestring

Authorized brand contact last name

businessDescriptionstring

Business description

companyLegalNamestring

Registered legal entity name

contactEmailstring

Brand contact email

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

Country-scoped carrier identifier type; omit for a single-option address country

industrystring

Industry

listNamestring

Sending list name

messagingTypestring

Messaging use case

optInFormUrlstring

Public customer-hosted opt-in URL

phoneNumberTypestring

Current immutable number type; a different value is rejected

privacyPolicyUrlstring

Privacy policy URL

promotionSummarystring

Messaging program summary

targetCountriesstring[]

Exactly one ISO 3166-1 alpha-2 target country

taxIdstring

Carrier registration identifier value

termsConditionsUrlstring

Terms & Conditions URL

verticalstring

TCR business vertical

websiteUrlstring

Business website URL

Example request

{
  "addressCountry": "GB",
  "identifierType": "vat",
  "targetCountries": [
    "US"
  ],
  "taxId": "GB421084435"
}

Response

Draft created

Changes

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