Bulk Add to Block ListBeta

Block up to 1,000 emails or domains in one call.

POSThttps://api.foxreach.io/api/v1/block-list/bulk

Requires an API key with the write scope.

Values already on the list count as duplicates, not errors. Invalid values are reported and the rest are still added.

Body Parameters#

valuesstring[]body

Emails or domains. Up to 1,000 across values and text.

textstringbody

Pasted text; split on whitespace, commas and semicolons.

notestringbody

Optional note stored on every new entry.

Response#

dataobject

Show data

createdinteger

New entries added.

duplicatesinteger

Already listed, or repeated in the request.

invalidinteger

Values that are not a valid email or domain.

invalidDetailsarray

First 100 invalid values, each with value and reason.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`422`	No values, or more than 1,000

Rate Limit#

100 requests per minute, shared by every bulk call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (bulk).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X POST "https://api.foxreach.io/api/v1/block-list/bulk" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"values": ["jane@acme.com", "competitor.com", "nope"]}'

Python SDK (beta)

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
result = client.block_list.bulk_add(["jane@acme.com", "competitor.com"])

TypeScript SDK (beta)

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const result = await client.blockList.bulkAdd({ values: ["jane@acme.com", "competitor.com"] });

Response

JSON

{
  "data": {
    "created": 2,
    "duplicates": 0,
    "invalid": 1,
    "invalidDetails": [{ "value": "nope", "reason": "Not a valid email or domain" }]
  }
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026