Skip to main content
POST
/
v1
/
bulkCampaigns
/
createBulkCampaign
/
{workspaceId}
cURL
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/bulkCampaigns/createBulkCampaign/{workspaceId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "campaignType": "sms",
  "assistantId": "<string>",
  "fromNumber": "<string>",
  "sheetURL": "<string>",
  "triggerType": "triggerImmediately",
  "description": "<string>",
  "ignorePreviousCampaigns": true,
  "message": "<string>",
  "templateName": "<string>",
  "templateLanguage": "<string>"
}
'
{
  "message": "Bulk Campaign triggered"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
workspaceId
string
required

Your workspace ID

Body

application/json

Details required to initiate the communication

​
name
string
required

Name of the Bulk Campaign

​
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

​
sheetURL
string
required

The URL of the Google Sheet

​
triggerType
enum<string>
required

The type of trigger to initiate the communication

Available options:
triggerImmediately,
triggerBasedOnCampaign
​
description
string | null

The description about the bulk Campaign

​
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)

Response

Communication initiated successfully

​
message
string

Bulk Campaign triggered