API Reference

Create a campaign under a brand

post
https://api.fractel.com/v2/messaging-brands//campaigns

Creates a new campaign for the specified brand

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The campaign's intended use (e.g., 2FA, MARKETING)

subUsecases
array of strings

Sub-use cases for additional campaign context

subUsecases
string

ID of reseller (if applicable)

string
required
length ≥ 40

Detailed description of the campaign's purpose

boolean
required

Whether the campaign uses embedded links

boolean
required

Whether the campaign uses embedded phone numbers

boolean
required
Defaults to true

Agreement to TCR terms

boolean
required

Whether campaign uses more than 50 numbers

boolean
required

Whether campaign contains age-gated content

boolean
required

Whether the campaign is for direct lending

boolean
required

Whether subscriber opt-in is required

boolean
required

Whether subscribers can opt out

boolean
required

Whether help options are available

string
required

Sample message 1

string

Sample message 2

string

Sample message 3

string

Sample message 4

string

Sample message 5

string
required

Description of subscriber opt-in flow

string
required

Sample help message

boolean
Defaults to true

Whether campaign auto-renews

string
length ≤ 50

CSP-managed reference identifier

boolean
Defaults to false

Signifies a mock campaign

string

Keywords for opt-in

string

Keywords for opt-out

string

Keywords for help

string

Sample opt-in message

string

Sample opt-out message

uri

Link to privacy policy

uri

Link to terms and conditions

string

Sample embedded link

mnoIds
array of strings

Specific MNOs to target

mnoIds
Metadata
string
required

Brand ID

Responses

Updated 6 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago