v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-07186533829.2 KB

product:chat

Create campaign

Creates a campaign

post/campaigns

create_channelsboolean

Whether to create channels for the campaign, if they don't exist

descriptionstring

The description of the campaign

idstring

namestring

The name of the campaign

segment_idsstring[]

The IDs of the segments to send the campaign to. Duplicate user IDs are removed. Use either user_ids or segment_ids, not both

sender_idstring required

The user ID of the sender

sender_mode'exclude' | 'include'

The sender mode of the campaign

sender_visibility'hidden' | 'archived'

The visibility of the created channels for the sender

show_channelsboolean

Whether the campaign should show channels, if they are hidden

skip_pushboolean

Whether to skip push notifications

skip_webhookboolean

Whether to skip webhooks

user_idsstring[]

The userIDs to send the campaign to. Use either segment ids or user ids not both

durationstring required

Duration of the request in milliseconds