coss.comdocs

Add an allow or block list entry

POST
/v1/risk/list_entries

Adds an email address (matched by mailbox), domain (with its subdomains), IP address or CIDR range, AS number, country or user id to the environment's allow or block list. An allow-list match makes the decision allow whatever else fired; a block-list match makes it block. Adding an entry that already exists returns it with status 200.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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"

Request Body

application/json
  1. body
list*RiskList
Value in"allow""block"
type*RiskListEntryType

email (matched by mailbox, dots and +tags folded), domain (subdomains included), ip (an address or CIDR range), asn, country (ISO 3166-1 alpha-2), user (your user id).

Value in"email""domain""ip""asn""country""user"
value*string
Length1 <= length <= 320
note?string
Lengthlength <= 500
expires_at?string

The entry stops matching at this time (it is kept until deleted).

Formatdate-time

Response Body

The entry already existed.

application/json
  1. response
object*"risk_list_entry"
Value in"risk_list_entry"
id*string
list*RiskList
Value in"allow""block"
type*RiskListEntryType

email (matched by mailbox, dots and +tags folded), domain (subdomains included), ip (an address or CIDR range), asn, country (ISO 3166-1 alpha-2), user (your user id).

Value in"email""domain""ip""asn""country""user"
value*string

Normalized: emails as their mailbox, CIDR ranges canonical, ASNs as numbers.

note*string|null
expires_at*|
Formatdate-time
created_at*string
Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.risk.lists.add("block", {  domain: "evil.example",  note: "Card testing",});
{  "object": "risk_list_entry",  "id": "rskle_01k7c8m4q2f3e9v6t5r1n0p8yz",  "list": "block",  "type": "domain",  "value": "evil.example",  "note": "Card testing",  "expires_at": null,  "created_at": "2026-01-15T09:30:00.000Z"}