Actions115
- Account Actions
- Agent Actions
- Agent Bot Actions
- Audit Log Actions
- Automation Rule Actions
- Campaign Actions
- Canned Response Actions
- Chat Room Actions
- Contact Actions
- Conversation Actions
- Custom Attribute Actions
- Custom Filter Actions
- Inbox Actions
- Integration Actions
- Message Actions
- Profile Actions
- Scheduled Message Actions
- Team Actions
- Webhook Actions
Campaign → Create
AI-generatedSummary
Create a new campaign specifying its title, message content, target inbox, scheduled run time, audience labels, and optional delivery settings.
Inputs
- campaignTitle (required) — Title of the campaign.
- campaignMessage (required) — Message content of the campaign.
- campaignInboxId (required) — Inbox ID targeted by the campaign.
- campaignScheduledAt (required) — ISO 8601 UTC date and time when the campaign should run.
- campaignTriggerOnlyDuringBusinessHours — Whether the campaign should trigger only during business hours.
- campaignTemplateParams — Optional template parameters object for campaign delivery rules.
- campaignAudienceLabels (required) — One or more labels used to build the campaign audience by their IDs.
Output shape
a single record
Returns the created campaign data as a single record. No pagination or envelope indicated.
Examples
Example 1: Creating a campaign to send a message to an inbox at a scheduled UTC datetime, targeting contacts with specified audience labels, optionally restricting delivery to business hours and using template parameters.
Specify campaign title, message, inbox ID, scheduled time, audience labels, and optionally template params and business hours trigger flag.