Skip to content
Pidgely Docs

API reference · Suppressions

Add suppressions in batch

POSThttps://api.pidgely.com/suppressions/batch/add
View as Markdown

Suppresses 1 to 100 addresses. The batch is not atomic: it stops at the first invalid address and keeps the ones added before it.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Body parameters

JSON object.

Name Type Required Description
emails string[] Yes Email addresses (1 to 100).

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.suppressions.batch.add({
  emails: ['a@example.com', 'b@example.com'],
});
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Suppressions.Batch.add({
    "emails": ["a@example.com", "b@example.com"],
})
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->suppressions->batch->add([
    'emails' => ['a@example.com', 'b@example.com'],
]);
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Suppressions.Batch.Add(ctx, &pidgely.AddSuppressionBatchRequest{
		Emails: []string{"a@example.com", "b@example.com"},
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Suppressions::Batch.add({
  emails: ["a@example.com", "b@example.com"]
})
puts result
cURL
curl -X POST 'https://api.pidgely.com/suppressions/batch/add' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "emails": [
    "a@example.com",
    "b@example.com"
  ]
}'

Response

200 OK

JSON
{
  "data": [
    {
      "object": "suppression",
      "id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21"
    }
  ]
}

Response fields

Name Type Required Description
data object[] No Items of this page.
data[].object string Yes Object type.
data[].id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.