agent-number-requests-v2

post/v2/agent/number-requests

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/agent/number-requests
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring required

Request body

addressCitystring

Request-owned registration field; optional fields may be cleared

addressCountrystring

Request-owned registration field; optional fields may be cleared

addressPostalCodestring

Request-owned registration field; optional fields may be cleared

addressStatestring

Request-owned registration field; optional fields may be cleared

addressStreetstring

Request-owned registration field; optional fields may be cleared

brandNamestring required
businessContactEmailstring

Request-owned registration field; optional fields may be cleared

businessContactFirstNamestring

Request-owned registration field; optional fields may be cleared

businessContactLastNamestring

Request-owned registration field; optional fields may be cleared

businessDescriptionstring

Request-owned registration field; optional fields may be cleared

companyLegalNamestring

Request-owned registration field; optional fields may be cleared

contactEmailstring

Request-owned registration field; optional fields may be cleared

contactPhonestring

Request-owned registration field; optional fields may be cleared

customDomainstring

Request-owned registration field; optional fields may be cleared

estimatedMonthlyVolumestring

Request-owned registration field; optional fields may be cleared

exampleSmsMessagestring

Request-owned registration field; optional fields may be cleared

identifierTypestring

Request-owned registration field; optional fields may be cleared

industrystring

Request-owned registration field; optional fields may be cleared

listNamestring

Request-owned registration field; optional fields may be cleared

messagingTypestring

Request-owned registration field; optional fields may be cleared

optInFormUrlstring

Request-owned registration field; optional fields may be cleared

phoneNumberType'toll_free' | '10dlc'
privacyPolicyUrlstring

Request-owned registration field; optional fields may be cleared

promotionSummarystring

Request-owned registration field; optional fields may be cleared

targetCountriesstring[]
taxIdstring

Request-owned registration field; optional fields may be cleared

termsConditionsUrlstring

Request-owned registration field; optional fields may be cleared

useOwnOptInUrlboolean
verticalstring

Request-owned registration field; optional fields may be cleared

websiteUrlstring

Request-owned registration field; optional fields may be cleared

Example request

{
  "phoneNumberType": "toll_free",
  "targetCountries": [
    "US"
  ]
}

Response

Inert draft created or replayed

requestobject

Bound request id/accountId/revision/status, fields, preview, domain, registration and nextActions

Changes

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