JavaScript SDK: swarmhit.blocklist.settings.get()
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/blocklist/settings"{ "data": { "addUnsubscribes": true }}Add to the blocklist POST
**JavaScript SDK:** [`swarmhit.blocklist.add(params)`](/sdk/methods#blocklist) Adds up to 1000 values: `values` as typed, each read as an email address, a domain (`acme.com`, `@acme.com` or a link to the site) or a LinkedIn profile link, or `entries` with their `type` given. An address also blocks its +tag forms (`jane@acme.com` blocks `jane+news@acme.com`). A domain covers its subdomains and matches email addresses only, so a lead with no email (LinkedIn only) is matched by its profile link. A personal email provider's domain (`gmail.com`) or a public suffix (`co.uk`) is refused: it would block everyone there. A LinkedIn profile is matched by its public identifier or its member id, whichever the lead is known by; a Sales Navigator link or id is refused (no profile read gives it back), as is an internationalized domain name for now. A value already on the list counts as `alreadyBlocked`; one that reads as none of these, or is refused, is returned in `invalid` with why. The leads in campaigns that the new entries match stop at once: up to 500 before the response (`stopped`), any more right after it, in the background (`stopping`).
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.