Skip to main content
POST
Count which selected prospects a bulk action applies to
Every bulk action takes a selection and works through it in batches:
  • selection is either { mode: "ids", ids: [prospectId, ...] } or { mode: "all", filters: { ready?, search?, groups? }, excludedIds: [...] } (every prospect matching the filters, minus the excluded ids).
  • Call POST /v3/outreach/prospects/bulk-preview with the selection and an action (delete, block, find-people or recheck) first. It changes nothing and returns eligibility: { selected, eligible, skipped, byReason }, e.g. sites skipped because a search is already running.
Each call processes one batch of eligible prospects and returns { success, succeeded, failed, nextCursor, eligibility, results }. While nextCursor is not null, call again with the same selection and afterId set to nextCursor. results has one entry per prospect with id, success and error when it failed. Find people adds creditsCharged, re-check adds pages, and block adds blocked and removed. Find people and re-check run in the background. Poll Outreach Prospects while a site’s status is finding_people or its analysis is rechecking, then read Outreach Contacts or linkStatus. Finding people does not buy email addresses; use Bulk people actions. POST /v3/outreach/prospects/selection returns the prospect rows a selection matches, for reads too large for a query string. For a single prospect, use Delete prospect. To reverse a block, see Unblock a domain.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Body

application/json
selection
object
required
action
enum<string>
required

The bulk action to count eligible rows for.

Available options:
delete,
block,
find-people,
recheck
teamId
string
reason
string

Why they were blocked, shown in the blocked list.

Maximum string length: 200
terms
string[]

Job titles to search for, matched as substrings and OR'd together - 'editor' finds 'Managing Editor'. Between 3 and 25 distinct terms; omit to use a sensible default covering editorial, SEO, marketing and owners.

Required array length: 3 - 25 elements

Response

Default Response

eligibility
object