Skip to main content

Update

Update a broadcast using the default context.

Parameters

*UpdateBroadcastRequest
required
The broadcast update parameters.

Returns

Returns an UpdateBroadcastResponse containing the updated broadcast ID.

Example


UpdateWithContext

Update a broadcast with a custom context.

Parameters

context.Context
required
Context for the request, useful for timeouts and cancellation.
*UpdateBroadcastRequest
required
The broadcast update parameters.

Returns

Returns an UpdateBroadcastResponse containing the updated broadcast ID.

Example


Types

UpdateBroadcastRequest

Request payload for updating a broadcast.
string
required
The ID of the broadcast to update.
string
The updated segment ID to send the broadcast to.
string
Deprecated: Use SegmentId instead. Audiences have been renamed to Segments.
string
The updated sender email address.
string
The updated email subject line.
[]string
Updated array of reply-to email addresses.
string
The updated HTML content of the broadcast.
string
The updated plain text content of the broadcast.
string
The updated internal name for the broadcast.
You can only update broadcasts that are in “draft” status. Sent or scheduled broadcasts cannot be modified.

UpdateBroadcastResponse

Response from updating a broadcast.
string
The unique identifier of the updated broadcast.