JavaScript SDK: swarmhit.blocklist.list(params?)
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.
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Query Parameters
Value in
- "email"
- "domain"
- "linkedin"
The start of a value, any case.
Page size, 1–100.
1 <= value <= 10050Number of records to skip.
0 <= value0Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/blocklist"{ "data": [ { "id": "string", "type": "email", "value": "string", "source": "app", "createdAt": "2019-08-24T14:15:22Z" } ], "paging": { "limit": 0, "offset": 0, "total": 0 }}Get the blocklist settings GET
**JavaScript SDK:** [`swarmhit.blocklist.settings.get()`](/sdk/methods#blocklist.settings)
Remove from the blocklist POST
**JavaScript SDK:** [`swarmhit.blocklist.remove(params)`](/sdk/methods#blocklist) 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).