Functions

create-broadcast

fn (request: POSTBroadcastsRequest): POSTBroadcastsResponse
fn (request: POSTBroadcastsRequest, opts: Map): POSTBroadcastsResponse

Create a new broadcast draft targeting a specific audience. Must be sent separately via send-or-schedule-broadcast.

Example

draft ::resend::broadcasts/create-broadcast(::resend::broadcasts/POSTBroadcastsRequest({
    name: "November update",
    audience_id: "78261eea-8f8b-4381-83c6-79fa7120f1cf",
    from: "news@example.com",
    subject: "What shipped in November",
    html: "<p>Hello.</p>"
}))
draft.id

remove-existing-broadcast-that-is-draft-status

fn (request: DELETEBroadcastsIdRequest): DELETEBroadcastsIdResponse
fn (request: DELETEBroadcastsIdRequest, opts: Map): DELETEBroadcastsIdResponse

Remove an existing broadcast. Only broadcasts in draft status can be deleted.

Example

result ::resend::broadcasts/remove-existing-broadcast-that-is-draft-status(::resend::broadcasts/DELETEBroadcastsIdRequest({id: "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794"}))
result.deleted

retrieve-list-broadcasts

fn (request: GETBroadcastsRequest): GETBroadcastsResponse
fn (request: GETBroadcastsRequest, opts: Map): GETBroadcastsResponse

Retrieve all broadcasts in your Resend account, including draft, scheduled, and sent.

Example

broadcasts ::resend::broadcasts/retrieve-list-broadcasts(::resend::broadcasts/GETBroadcastsRequest({}))
map(broadcasts.data, %.status)

retrieve-single-broadcast

fn (request: GETBroadcastsIdRequest): GETBroadcastsIdResponse
fn (request: GETBroadcastsIdRequest, opts: Map): GETBroadcastsIdResponse

Retrieve a single broadcast by its ID, including status, schedule, and content details.

Example

broadcast ::resend::broadcasts/retrieve-single-broadcast(::resend::broadcasts/GETBroadcastsIdRequest({id: "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794"}))
broadcast.status

send-or-schedule-broadcast

fn (id: Str, request: POSTBroadcastsIdSendRequest): POSTBroadcastsIdSendResponse
fn (id: Str, request: POSTBroadcastsIdSendRequest, opts: Map): POSTBroadcastsIdSendResponse

Send a broadcast immediately or schedule it for later delivery via scheduled_at.

Example

// Send now
::resend::broadcasts/send-or-schedule-broadcast("49a3999c-0ce1-4ea6-ab68-afcd6dc2e794", ::resend::broadcasts/POSTBroadcastsIdSendRequest({}))

// Or schedule it
scheduled ::resend::broadcasts/send-or-schedule-broadcast("49a3999c-0ce1-4ea6-ab68-afcd6dc2e794", ::resend::broadcasts/POSTBroadcastsIdSendRequest({
    scheduled_at: "2026-12-01T09:00:00Z"
}))
scheduled.id

Types

CreateBroadcastOptions

CreateBroadcastOptions type {
    name: Str?,
    audience_id: Str,
    from: Str,
    subject: Str,
    reply_to: Vec<Str>?,
    preview_text: Str?,
    html: Str?,
    text: Str?
}

CreateBroadcastResponseSuccess

CreateBroadcastResponseSuccess type {
    id: Str?,
    object: Str?
}

DELETEBroadcastsIdRequest

DELETEBroadcastsIdRequest type {
    id: Str
}

DELETEBroadcastsIdResponse

DELETEBroadcastsIdResponse type {
    id: Str?,
    object: Str?,
    deleted: Bool?
}

GETBroadcastsIdRequest

GETBroadcastsIdRequest type {
    id: Str
}

GETBroadcastsIdResponse

GETBroadcastsIdResponse type {
    id: Str?,
    name: Str?,
    audience_id: Str?,
    from: Str?,
    subject: Str?,
    reply_to: Vec<Str>?,
    preview_text: Str?,
    status: Str?,
    created_at: Str?,
    scheduled_at: Str?,
    sent_at: Str?
}

GETBroadcastsRequest

GETBroadcastsRequest type Map

GETBroadcastsResponse

GETBroadcastsResponse type {
    object: Str?,
    data: Vec<Map>?
}

GetBroadcastResponseSuccess

GetBroadcastResponseSuccess type {
    id: Str?,
    name: Str?,
    audience_id: Str?,
    from: Str?,
    subject: Str?,
    reply_to: Vec<Str>?,
    preview_text: Str?,
    status: Str?,
    created_at: Str?,
    scheduled_at: Str?,
    sent_at: Str?
}

ListBroadcastsResponseSuccess

ListBroadcastsResponseSuccess type {
    object: Str?,
    data: Vec<Map>?
}

POSTBroadcastsIdSendRequest

POSTBroadcastsIdSendRequest type {
    scheduled_at: Str?
}

POSTBroadcastsIdSendResponse

POSTBroadcastsIdSendResponse type {
    id: Str?
}

POSTBroadcastsRequest

POSTBroadcastsRequest type {
    name: Str?,
    audience_id: Str,
    from: Str,
    subject: Str,
    reply_to: Vec<Str>?,
    preview_text: Str?,
    html: Str?,
    text: Str?
}

POSTBroadcastsResponse

POSTBroadcastsResponse type {
    id: Str?,
    object: Str?
}

RemoveBroadcastResponseSuccess

RemoveBroadcastResponseSuccess type {
    id: Str?,
    object: Str?,
    deleted: Bool?
}

SendBroadcastOptions

SendBroadcastOptions type {
    scheduled_at: Str?
}

SendBroadcastResponseSuccess

SendBroadcastResponseSuccess type {
    id: Str?
}