Interface CanvasTriggerSendObject

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

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

interface CanvasTriggerSendObject {
    audience?: ConnectedAudienceObject;
    broadcast?: boolean;
    canvas_entry_properties?: object;
    canvas_id: string;
    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
}

Hierarchy (view full)

CanvasTriggerSendObject
- CanvasTriggerScheduleCreateObject

Index

Properties

audience? broadcast? canvas_entry_properties? canvas_id recipients?

Properties

`Optional`audience

audience?: ConnectedAudienceObject

`Optional`broadcast

broadcast?: boolean

`Optional`canvas_entry_properties

canvas_entry_properties?: object

canvas_id

canvas_id: string

`Optional`recipients

recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]