product:chat

Create campaign

Creates a campaign

post/campaigns

Request

Base URL
https://chat.stream-io-api.com
URL
https://chat.stream-io-api.com/campaigns
Auth
- API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
- or API key in query parameter api_key and API key in header Stream-Auth-Type

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

Oct 28, 2026678ca18d68f0 Revision changes
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
Oct 12, 202630f95dce0284 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status