coss.comdocs
GitHub

Check whether an address is suppressed

GET
/v1/suppressions/check

Whether a send to address (with category, if given) would skip it, and the entries that match: those with scope * and, with a category, those for that category.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Query Parameters

address*string

The address to check.

category?string

The category of the email you plan to send. Without it, only * entries count.

Match^[A-Za-z0-9_-]{1,256}$

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The result.

application/json
  1. response
object*"suppression_check"
Value in"suppression_check"
address*string
suppressed*boolean

Whether a send (with the given category) would skip this address.

suppressions*array<>

The entries that match.

import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.suppressions.check({  address: "user@example.com",});
{  "object": "suppression_check",  "address": "user@example.com",  "suppressed": true,  "suppressions": [    {      "object": "suppression",      "id": "sup_01k7c8m4q2f3e9v6t5r1n0p8yz",      "address": "user@example.com",      "scope": "marketing",      "reason": "manual",      "email_id": null,      "created_at": "2026-01-15T09:30:00.000Z"    }  ]}