Skip to main content
Retrieves detailed information about a specific broadcast.

Methods

Get

Retrieves a broadcast using the default background context.

GetWithContext

Retrieves a broadcast with a custom context for cancellation and timeout control.

Parameters

string
required
The unique identifier of the broadcast to retrieve.

Response

string
The object type, always broadcast.
string
The unique identifier for the broadcast.
string
The name of the broadcast.
string
The ID of the segment this broadcast is sent to.
string
The sender email address.
string
The email subject line.
string[]
An array of reply-to email addresses.
string
The HTML content of the email.
string
The plain text content of the email.
string
The preview text that appears in email clients.
string
The current status of the broadcast (e.g., “draft”, “scheduled”, “sent”).
string
ISO 8601 timestamp of when the broadcast was created.
string
ISO 8601 timestamp of when the broadcast is scheduled to be sent.
string
ISO 8601 timestamp of when the broadcast was sent.
string
deprecated
Deprecated. Use segment_id instead.

Example