Skip to main content
POST
Submit A2P campaign registration

Authorizations

x-api-key
string
header
required

API Key for authentication

Body

application/json
brandRegistrationSid
string
required

Brand registration SID

messagingServiceSid
string
required

Messaging service SID

campaignId
string
required

Campaign ID

optInMessage
string
required

Opt-in message

optOutMessage
string
required

Opt-out message

helpMessage
string
required

Help message

optInKeywords
string[]
required

Opt-in keywords

optOutKeywords
string[]
required

Opt-out keywords

helpKeywords
string[]
required

Help keywords

Response

A2P campaign registration submitted successfully

sid
string

Campaign SID

account_sid
string

Account SID

messaging_service_sid
string

Messaging service SID

brand_registration_sid
string

Brand registration SID

campaign_id
string

Campaign ID

campaign_status
string

Campaign status

opt_in_message
string

Opt-in message

opt_out_message
string

Opt-out message

help_message
string

Help message

opt_in_keywords
string[]

Opt-in keywords

opt_out_keywords
string[]

Opt-out keywords

help_keywords
string[]

Help keywords

date_created
string

Creation date

date_updated
string

Last update date

url
string

Resource URL