PlatformDocs

Remove or block leads

Remove leads you do not want, or keep a company or person out of your automations.

Hide a lead (reversible) or delete leads for good from your own code. Neither gives the credit back. Authenticated with ?privateKey=YOUR_KEY (see Authentication).

POST/v3/leads/{leadId}/hideHide or unhide a lead
POST/v3/leads/deleteDelete leads permanently
POST
Try:
Request body
Lead IdLead id (the _id of a row returned by get_leads).
Hidetrue (default) hides the lead; false makes a hidden lead visible again.
curl -X POST "https://rest-dash.revealid.xyz/v3/leads/6530c1d2e3f4a5b6c7d8e9f2/hide?privateKey=YOUR_KEY" \  -H "Content-Type: application/json" \  -d '{  "hide": true}'
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
leadId*string—any
hideboolean—any

Use case: Hide test leads

POST /v3/leads/{leadId}/hide with { "hide": true } hides one lead; it disappears from GET /v3/leads but keeps its data. { "hide": false } brings it back. Hiding an already hidden lead answers Lead is already hidden.

Use case: Delete leads for good

POST /v3/leads/delete with { "leadIds": ["6530c1d2e3f4a5b6c7d8e9f2", "6530c1d2e3f4a5b6c7d8e9f5"] } deletes several leads of one website. This cannot be undone, and the companies of the deleted leads are added to the website's Exclude list, so new leads from them stop appearing. The response's deletedCount says how many were deleted (leads outside your account are skipped).

On this page