Create and schedule an RCS campaign

Create and schedule an RCS campaign to target a user segment. Use @once to run once. For recurring campaigns use cron expression (minute hour day month weekday).

Query Parameters
bot string — REQUIRED Unique identifier of the AI agent (bot)

Request Body — REQUIRED
botId string — REQUIRED Unique ID of the bot
name string — REQUIRED Unique name of the campaign
description string Description of the campaign
source string — REQUIRED Source of the campaign. For this API, it should be 'rcsBusinessMessaging'.
executionTime string Campaign execution schedule in cron format (minute hour day month weekday). Example - "25 20 20 6 *" Runs at 8:25 PM on June 20 every year
segmentId string Unique ID of the target audience segment for the campaign
segmentName string Name of the target audience segment for the campaign
templateName string Name of the template to be used for the campaign
type string Type of the campaign
recipientColumnName string Name of the column containing recipient phone numbers
schedule string — REQUIRED Campaign execution time, using cron expression. Use @once for one-time schedule.
allUsers boolean Set to true to send the campaign to all users.
content object — REQUIRED message string
info object campaignMetaData object schedule string Campaign execution time, using cron expression or @once for one-time schedule. timezone string Timezone in which the campaign is scheduled. executionTime string Campaign execution schedule in cron format (minute hour day month weekday). Example - "25 20 20 6 *" Runs at 8:25 PM on June 20 every year columnsMapping object campaignGoalMetaData object type string Type of the campaign goal. For this API, it should be 'delivery'. validity object unit string value integer statusToTrack string Status to track for the campaign goal.
jobPayload object campaignName string Unique name of the campaign segmentName string Name of the target audience segment. segmentId string Unique ID of the target audience segment. schedule string Campaign execution time, using cron expression. Use @once for one-time schedule. timezone string executionTime string Campaign execution schedule in cron format (minute hour day month weekday). Example - "25 20 20 6 *" Runs at 8:25 PM on June 20 every year content string audienceId string options object botId string

Responses
201 Campaign created and scheduled Schema — OPTIONAL campaignId string — OPTIONAL status string — OPTIONAL scheduledAt date-time — OPTIONAL
400 Bad request Schema — OPTIONAL code string message string
401 Unauthorized Schema — OPTIONAL code string message string
409 Conflict — duplicate campaign or invalid state Schema — OPTIONAL code string message string
500 Server error Schema — OPTIONAL code string message string