Interface CampaignsTriggerScheduleCreateObject

Request body for schedule API-triggered campaigns.

https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns/#request-body

interface CampaignsTriggerScheduleCreateObject {
    audience?: ConnectedAudienceObject;
    broadcast?: boolean;
    campaign_id: string;
    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
    schedule: ScheduleObject;
    send_id?: string;
    trigger_properties?: object;
}

Hierarchy (View Summary)

CampaignsTriggerSendObject
- CampaignsTriggerScheduleCreateObject

Index

Properties

audience? broadcast? campaign_id recipients? schedule send_id? trigger_properties?

Properties

`Optional`audience

audience?: ConnectedAudienceObject

`Optional`broadcast

broadcast?: boolean

campaign_id

campaign_id: string

`Optional`recipients

recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

schedule

schedule: ScheduleObject

`Optional`send_id

send_id?: string

`Optional`trigger_properties

trigger_properties?: object