Server URLloading...

POST

/blocklist

Send

Authorization

Body

JavaScript SDK: swarmhit.blocklist.add(params)

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).

Response Body

curl -X POST "https://example.com/blocklist" \  -H "Content-Type: application/json" \  -d '{    "values": [      "jane@acme.com",      "competitor.com",      "https://www.linkedin.com/in/john-roe"    ]  }'

{  "data": {    "added": 0,    "alreadyBlocked": 0,    "invalid": [      {        "value": "string",        "reason": "string"      }    ],    "stopped": 0,    "stopping": 0  }}