Skip to main content
Resend Docs

Search documentation

Type to search this documentation.

On this pageOverview

Add Batch Suppressions

POST

/

suppressions

/

batch

/

add

Node.js
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.suppressions.batch.add({
  emails: ['steve.wozniak@example.com', 'susan.kare@example.com'],
});
PHP
$resend = Resend::client('re_xxxxxxxxx');

$resend->suppressions->batch->add([
  'emails' => ['steve.wozniak@example.com', 'susan.kare@example.com'],
]);
Python
import resend

resend.api_key = "re_xxxxxxxxx"

params: resend.Suppressions.Batch.AddParams = {
  "emails": ["steve.wozniak@example.com", "susan.kare@example.com"],
}

resend.Suppressions.Batch.add(params)
Ruby
require "resend"

Resend.api_key = "re_xxxxxxxxx"

Resend::Suppressions::Batch.add(
  emails: ["steve.wozniak@example.com", "susan.kare@example.com"]
)
Go
package main

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

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

	params := &resend.BatchAddSuppressionsRequest{
		Emails: []string{"steve.wozniak@example.com", "susan.kare@example.com"},
	}

	client.Suppressions.Batch.Add(params)
}
Rust
use resend_rs::types::BatchAddSuppressionOptions;
use resend_rs::{Resend, Result};

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

  let opts =
    BatchAddSuppressionOptions::from(vec!["steve.wozniak@example.com", "susan.kare@example.com"]);
  let _data = resend.suppressions.batch_add(opts).await?;

  Ok(())
}
Java
import com.resend.Resend;
import com.resend.core.exception.ResendException;
import com.resend.services.suppressions.model.AddSuppressionsOptions;
import java.util.List;

public class Main {
    public static void main(String[] args) throws ResendException {
        Resend resend = new Resend("re_xxxxxxxxx");

        AddSuppressionsOptions options = AddSuppressionsOptions.builder()
                .emails(List.of("steve.wozniak@example.com", "susan.kare@example.com"))
                .build();

        resend.suppressions().batch().add(options);
    }
}
.NET
using Resend;

IResend resend = ResendClient.Create( "re_xxxxxxxxx" );

var resp = await resend.SuppressionBatchAddAsync( new[]
{
    "steve.wozniak@example.com",
    "susan.kare@example.com",
} );
cURL
curl -X POST 'https://api.resend.com/suppressions/batch/add' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "emails": ["steve.wozniak@example.com", "susan.kare@example.com"]
}'
CLI
resend suppressions batch add --file suppressions.json
Response
{
  "data": [
    {
      "object": "suppression",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3"
    },
    {
      "object": "suppression",
      "id": "520784e2-887d-4c25-b53c-4ad46ad38100"
    }
  ]
}

array

required

The email addresses to suppress. Must contain between 1 and 100 email addresses.

Node.js
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.suppressions.batch.add({
  emails: ['steve.wozniak@example.com', 'susan.kare@example.com'],
});
PHP
$resend = Resend::client('re_xxxxxxxxx');

$resend->suppressions->batch->add([
  'emails' => ['steve.wozniak@example.com', 'susan.kare@example.com'],
]);
Python
import resend

resend.api_key = "re_xxxxxxxxx"

params: resend.Suppressions.Batch.AddParams = {
  "emails": ["steve.wozniak@example.com", "susan.kare@example.com"],
}

resend.Suppressions.Batch.add(params)
Ruby
require "resend"

Resend.api_key = "re_xxxxxxxxx"

Resend::Suppressions::Batch.add(
  emails: ["steve.wozniak@example.com", "susan.kare@example.com"]
)
Go
package main

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

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

	params := &resend.BatchAddSuppressionsRequest{
		Emails: []string{"steve.wozniak@example.com", "susan.kare@example.com"},
	}

	client.Suppressions.Batch.Add(params)
}
Rust
use resend_rs::types::BatchAddSuppressionOptions;
use resend_rs::{Resend, Result};

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

  let opts =
    BatchAddSuppressionOptions::from(vec!["steve.wozniak@example.com", "susan.kare@example.com"]);
  let _data = resend.suppressions.batch_add(opts).await?;

  Ok(())
}
Java
import com.resend.Resend;
import com.resend.core.exception.ResendException;
import com.resend.services.suppressions.model.AddSuppressionsOptions;
import java.util.List;

public class Main {
    public static void main(String[] args) throws ResendException {
        Resend resend = new Resend("re_xxxxxxxxx");

        AddSuppressionsOptions options = AddSuppressionsOptions.builder()
                .emails(List.of("steve.wozniak@example.com", "susan.kare@example.com"))
                .build();

        resend.suppressions().batch().add(options);
    }
}
.NET
using Resend;

IResend resend = ResendClient.Create( "re_xxxxxxxxx" );

var resp = await resend.SuppressionBatchAddAsync( new[]
{
    "steve.wozniak@example.com",
    "susan.kare@example.com",
} );
cURL
curl -X POST 'https://api.resend.com/suppressions/batch/add' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "emails": ["steve.wozniak@example.com", "susan.kare@example.com"]
}'
CLI
resend suppressions batch add --file suppressions.json
JSON
{
  "data": [
    {
      "object": "suppression",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3"
    },
    {
      "object": "suppression",
      "id": "520784e2-887d-4c25-b53c-4ad46ad38100"
    }
  ]
}

Was this page helpful?

⌘I

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu