Cancel Broadcast

POST

broadcasts

:broadcast_id

cancel

Node.js

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.broadcasts.cancel(
  '559ac32e-9ef5-46fb-82a1-b76b840c0f7b',
);

PHP

$resend = Resend::client('re_xxxxxxxxx');

$resend->broadcasts->cancel('559ac32e-9ef5-46fb-82a1-b76b840c0f7b');

Python

import resend

resend.api_key = "re_xxxxxxxxx"

resend.Broadcasts.cancel(id="559ac32e-9ef5-46fb-82a1-b76b840c0f7b")

Ruby

require "resend"

Resend.api_key = "re_xxxxxxxxx"

Resend::Broadcasts.cancel("559ac32e-9ef5-46fb-82a1-b76b840c0f7b")

package main

import "github.com/resend/resend-go/v4"

func main() {
	client := resend.NewClient("re_xxxxxxxxx")

	client.Broadcasts.Cancel("559ac32e-9ef5-46fb-82a1-b76b840c0f7b")
}

Rust

use resend_rs::{Resend, Result};

#[tokio::main]
async fn main() -> Result<()> {
  let resend = Resend::new("re_xxxxxxxxx");

  let _canceled = resend
    .broadcasts
    .cancel("559ac32e-9ef5-46fb-82a1-b76b840c0f7b")
    .await?;

  Ok(())
}

Java

import com.resend.Resend;
import com.resend.services.broadcasts.model.CancelBroadcastResponseSuccess;

Resend resend = new Resend("re_xxxxxxxxx");

CancelBroadcastResponseSuccess data = resend.broadcasts().cancel("559ac32e-9ef5-46fb-82a1-b76b840c0f7b");

.NET

using Resend;

IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI

await resend.BroadcastCancelAsync( new Guid( "559ac32e-9ef5-46fb-82a1-b76b840c0f7b" ) );

cURL

curl -X POST 'https://api.resend.com/broadcasts/559ac32e-9ef5-46fb-82a1-b76b840c0f7b/cancel' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json'

CLI

resend broadcasts cancel 559ac32e-9ef5-46fb-82a1-b76b840c0f7b

Response

{
  "object": "broadcast",
  "id": "559ac32e-9ef5-46fb-82a1-b76b840c0f7b"
}

You can only cancel Broadcasts that are queued or scheduled. When you cancel a Broadcast, here’s what happens based on its status:

scheduled → draft: no emails are sent. You can update the Broadcast and reschedule it to be sent.
queued → canceled: emails that have already been sent are not affected, but any emails still in the queue will no longer be sent.

Path Parameters