Skip to main content
POST
/
v1
/
campaigns
/
createCampaign
/
{workspaceId}
cURL
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/campaigns/createCampaign/{workspaceId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "campaignType": "sms",
  "assistantId": "<string>",
  "fromNumber": "<string>",
  "toNumber": "<string>",
  "triggerType": "triggerImmediately",
  "ignorePreviousCampaigns": true,
  "message": "<string>",
  "templateName": "<string>",
  "templateLanguage": "<string>",
  "attributes": {
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>"
  }
}
'
{
  "message": "Campaign created/updated with id: {campaignID}"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
workspaceId
string
required

Your workspace ID

Body

application/json

Details required to initiate the communication

​
campaignType
enum<string>
required

The type of campaign

Available options:
sms,
call,
whatsapp
​
assistantId
string
required

The ID of the assistant

​
fromNumber
string
required

Sender's number

​
toNumber
string
required

Recipient's number

​
triggerType
enum<string>
required

The type of trigger to initiate the communication

Available options:
triggerImmediately,
triggerBasedOnCampaign
​
ignorePreviousCampaigns
boolean

Ignore the previous campaign history of a contact and reach out again

​
message
string | null

The message content (Required for SMS)

​
templateName
string | null

Name of the approved WhatsApp template (Required for WHATSAPP)

​
templateLanguage
string | null

Language of the template (Required for WHATSAPP)

​
attributes
object

Additional attributes for the communication

Response

Communication initiated successfully

​
message
string

Confirmation message indicating the call or SMS was placed