Interface CampaignsTriggerSendObject

Request body for sending campaign messages via API-triggered delivery.

https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/#request-body

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

Hierarchy (view full)

Properties

audience? broadcast? campaign_id recipients? send_id? trigger_properties?

Properties

Optionalaudience

audience?: ConnectedAudienceObject

Optionalbroadcast

broadcast?: boolean

campaign_id

campaign_id: string

Optionalrecipients

recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

Optionalsend_id

send_id?: string

Optionaltrigger_properties

trigger_properties?: object

Settings

Member Visibility

On This Page

Properties