TWtwilio
TrusthubV1A2PCampaignRegistrations

Create a new A2P Campaign Registration and initialize an embedded compliance session.

Changed on

Create a new A2P Campaign Registration and initialize an embedded compliance session.

post/v1/A2PCampaignRegistrations

Request

  • Base URL
    https://trusthub.twilio.com
  • URL
    https://trusthub.twilio.com/v1/A2PCampaignRegistrations
  • Auth
    HTTP basic

Request body

a2pBrandRegistrationSidstring required

The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the id returned by the Initialize Brand endpoint (which is formatted as tri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/{Sid} on messaging.twilio.com.

messagingServiceSidstring

The SID of the Messaging Service.

themeSetIdstring

Theme ID for styling the inquiry form.

useCaseCategoriesstring[]

The categories of the messaging use case.

useCaseDescriptionstring

A description of the messaging use case.

useCaseSampleMessage1string

A sample message for the use case.

useCaseSampleMessage2string

A second sample message for the use case.

useCaseSampleMessage3string

A third sample message for the use case.

useCaseSampleMessage4string

A fourth sample message for the use case.

useCaseSampleMessage5string

A fifth sample message for the use case.

useCaseOptInTypesstring[]

The opt-in methods for the use case.

useCaseOptInDescriptionstring

A description of the opt-in process.

hasEmbeddedLinksboolean

Whether messages will contain embedded links.

hasEmbeddedPhoneboolean

Whether messages will contain embedded phone numbers.

embeddedUrlSamplestring uri

A sample URL that will be embedded in messages (must use https://).

directLendingboolean

Whether the campaign involves direct lending.

ageGatedboolean

Whether the content is age-gated.

privacyPolicyUrlstring uri

The URL to the privacy policy.

termsAndConditionsUrlstring uri

The URL to the terms and conditions.

optInKeywordsstring[]

Keywords users can text to opt in.

optInMessageSamplestring

A sample opt-in confirmation message.

optOutKeywordsstring[]

Keywords users can text to opt out.

optOutMessageSamplestring

A sample opt-out confirmation message.

helpKeywordsstring[]

Keywords users can text for help.

helpMessageSamplestring

A sample help message.

Response

Created

idstring nullable

The unique A2P Brand or Campaign Registration identifier, formatted as tri1.us1.account.AC.../registration.BU....

sessionIdstring nullable

The Persona inquiry ID used to start the embedded compliance session.

sessionTokenstring nullable

The Persona session token for embedding the compliance UI. Expires in 24 hours.

Changes