Sign in

v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Telephony - A2P Campaigns

Create A2P campaign

Register a new A2P campaign for 10DLC messaging.

post/internal/telephony/a2p-campaigns

Request body

workspaceIdstring uuid required

Workspace ID

brandIdstring uuid required

A2P Brand ID

useCase'ACCOUNT_NOTIFICATION' | 'AGENTS_FRANCHISES' | 'CARRIER_EXEMPT' | 'CHARITY' | 'CONVERSATIONAL' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'EMERGENCY' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'K12_EDUCATION' | 'LOW_VOLUME' | 'MARKETING' | 'MIXED' | 'POLITICAL' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT' | 'SOCIAL' | 'SWEEPSTAKES' | 'TWO_FACTOR_AUTH' required

Campaign use case

descriptionstring required

Campaign description

sample1string
sample2string
messageFlowstring
helpMessagestring
helpKeywordsstring
optinMessagestring
optinKeywordsstring
optoutMessagestring
optoutKeywordsstring
subscriberOptinboolean
subscriberOptoutboolean
subscriberHelpboolean
embeddedLinkboolean
embeddedPhoneboolean
numberPoolboolean
ageGatedboolean
directLendingboolean
autoRenewalboolean

Example request

{
  "useCase": "CUSTOMER_CARE"
}

Response

A2P campaign created

idstring uuid required

Unique identifier

workspaceIdstring uuid required

Workspace ID

brandIdstring uuid required

A2P Brand ID

providerIdstring nullable required

Provider campaign ID

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

Campaign status

useCase'ACCOUNT_NOTIFICATION' | 'AGENTS_FRANCHISES' | 'CARRIER_EXEMPT' | 'CHARITY' | 'CONVERSATIONAL' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'EMERGENCY' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'K12_EDUCATION' | 'LOW_VOLUME' | 'MARKETING' | 'MIXED' | 'POLITICAL' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT' | 'SOCIAL' | 'SWEEPSTAKES' | 'TWO_FACTOR_AUTH' required

Campaign use case

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "status": "approved",
  "useCase": "CUSTOMER_CARE"
}