Sign in

v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Telephony - A2P Brands

Create A2P brand

Register a new A2P brand for 10DLC messaging.

post/internal/telephony/a2p-brands

Request body

workspaceIdstring uuid required

Workspace ID

businessNamestring required

Business name

displayNamestring required

Display name

entityType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'SOLE_PROPRIETOR' | 'GOVERNMENT' required

Business entity type

vertical'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION' required

Business vertical

einstring

EIN

firstNamestring
lastNamestring
phonestring
emailstring email
streetstring
citystring
statestring
postalCodestring
countrystring
websitestring uri
isResellerboolean

Example request

{
  "businessName": "Acme Corp",
  "displayName": "Acme",
  "entityType": "PRIVATE_PROFIT",
  "vertical": "TECHNOLOGY",
  "ein": "12-3456789"
}

Response

A2P brand created

idstring uuid required

Unique identifier

workspaceIdstring uuid required

Workspace ID

providerIdstring nullable required

Provider brand ID

status'pending' | 'approved' | 'failed' required

Brand status

businessNamestring required

Business name

einstring nullable required

EIN number

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "status": "approved",
  "businessName": "Acme Corp",
  "ein": "12-3456789"
}