Skip to main content
POST
Create and trigger a Campaign

Authorizations

apiKey
string
header
required

Body

application/json
sender
string
required

The Clerk phone number or identifier from which campaign messages will be sent

Example:

"+1415456789"

listName
string
required

The name of the list containing the contacts the campaign will be sent to

Example:

"PremiumTierSubscribers"

mediaUrls
string[]
required

The media URLs to send with the campaign message

Example:
body
string
required

The message text

Example:

"Hello, world!"

provider
enum<string>

The provider to send the message from

Available options:
twilio,
bandwidth,
msteams,
other,
non_voip,
whatsapp,
telnyx,
webex,
rcs
Example:

"whatsapp"

name
string

An optional name for the campaign

Example:

"Sale Reminder"

Response

The created campaign

data
object
required