JavaScript SDK: swarmhit.blocklist.remove(params)
Removes up to 1000 entries: values read as when they were added, or
entries as { type, value } (as GET /blocklist lists them).
Entries not on the list are ignored; values that read as none are
returned in invalid. Leads the entries already stopped stay stopped.
Takes an owner or admin: the API key's creator, of this workspace or of
its organization (403 code: not-allowed otherwise).
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
values, entries, or both: up to 1000 in all.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/blocklist/remove" \ -H "Content-Type: application/json" \ -d '{ "entries": [ { "type": "linkedin", "value": "john-roe" } ] }'{ "data": { "removed": 0, "invalid": [ { "value": "string", "reason": "string" } ] }}List the blocklist GET
**JavaScript SDK:** [`swarmhit.blocklist.list(params?)`](/sdk/methods#blocklist) The workspace blocklist, newest first: people and companies never enrolled or contacted, on any channel. A lead matching an entry is not added to a campaign (it counts as `blocklisted`); a lead already in a campaign stops as soon as the entry is added, or at its next step (status `stopped`, with a `blocklisted` entry in its `history`), and its open call tasks close; a direct action or email to them is refused with 409 `code: blocklisted`. A reply in an existing conversation, from the inbox or through `POST /inbox/chats/{id}/messages`, still goes out.
Remove one blocklist entry DELETE
**JavaScript SDK:** [`swarmhit.blocklist.delete(blocklistId)`](/sdk/methods#blocklist) Leads it already stopped stay stopped. Takes an owner or admin, as removing entries does (403 `code: not-allowed` otherwise).