Block many addresses or domains

Server URLloading...

POST

/api/v1/blocklist/bulk

Send

Authorization

BearerAuth

Your API key from app.argorant.com/profile, sent as `Authorization: Bearer <key>`. A connector sign-in token (ag_mcp_...) works the same way.

Authorization (Header)string

Header

Idempotency-Keystring

X-Request-Idstring

Body

valuesarray, JSON[ "competitor.com", "jane@acme.com" ]

Up to 5,000 email addresses or domains.

csvstring

CSV text instead of values, up to 5,000 rows and 2,000,000 characters.

campaign_idsarray, JSON[]

Block only in these campaigns, up to 50.

reasonstring

Why, for your own records (default manual).

dry_runboolean

true

 Not senttruefalse

true only counts and changes nothing.

Up to 5,000 email addresses or domains per call, as values or as csv text (the first address or domain of each row counts; a header row is fine). Send more in several calls. Without campaign_ids the blocks cover every campaign of the workspace; with campaign_ids (up to 50, and values times campaigns at most 50,000) only those campaigns. Send dry_run: true first to see how many entries would be added and how many people waiting in campaigns would be stopped; nothing changes. Up to 500 new entries are done in the call. More are saved and applied in the background: the answer is 202 with a job_id to follow at GET /api/v1/blocklist/jobs/{job_id}. Entries are saved before people are stopped, so a block always holds.

Header Parameters

Response Body

curl -X POST "https://app.argorant.com/api/v1/blocklist/bulk" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "values": [      "competitor.com",      "jane@acme.com"    ],    "dry_run": true  }'

{  "ok": true,  "dry_run": true,  "found": 2,  "invalid": 0,  "invalid_examples": [],  "duplicates": 0,  "scope": "workspace",  "would_add": 2,  "already_listed": 0,  "leads_to_stop": 37,  "complete": true,  "status": "done",  "job_id": "5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716",  "summary": "2 new entries would be added (0 already listed). 37 campaign leads would be stopped."}