Sign in
Broadcasts

Retrieve a single broadcast

get/broadcasts/{id}

Path parameters

idstring required

The Broadcast ID.

Response

OK

idstring

Unique identifier for the broadcast.

namestring

Name of the broadcast.

audience_idstring nullable

Deprecated: use segment_id instead. Unique identifier of the segment this broadcast will be sent to.

segment_idstring nullable

Unique identifier of the segment this broadcast will be sent to.

fromstring

The email address of the sender.

subjectstring

The subject line of the email.

reply_tostring[]

The email addresses to which replies should be sent.

preview_textstring

The preview text of the email.

statusstring

The status of the broadcast.

created_atstring

Timestamp indicating when the broadcast was created.

scheduled_atstring

Timestamp indicating when the broadcast is scheduled to be sent.

sent_atstring

Timestamp indicating when the broadcast was sent.

textstring nullable

The plain text version of the broadcast content.

htmlstring nullable

The HTML version of the broadcast content.

topic_idstring nullable

The topic ID that the broadcast is scoped to.

Example response

{
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "name": "November announcements",
  "from": "Acme <onboarding@resend.dev>",
  "subject": "Hello World",
  "preview_text": "Here are our announcements",
  "status": "draft",
  "created_at": "2023-10-06 22:59:55.977+00",
  "scheduled_at": "2023-10-06 22:59:55.977+00",
  "sent_at": "2023-10-06 22:59:55.977+00",
  "text": "Hello {{{FIRST_NAME|there}}}!",
  "html": "<p>Hello {{{FIRST_NAME|there}}}!</p>",
  "topic_id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e"
}

Changes