Skip to main content
POST
Count which selected articles a bulk action applies to
Every bulk action takes a selection and works through it in batches:
  • selection is either { mode: "ids", ids: [articleSlug, ...] } or { mode: "all", filters: { search? }, excludedIds: [...] } (every article matching the filters, minus the excluded slugs).
  • Call POST /v3/cms/articles/bulk-preview with the selection and an action first. It changes nothing and returns eligibility: { selected, eligible, skipped, byReason }, e.g. articles skipped because they are not generated yet.
Each call processes one batch of eligible articles 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 article with id, articleSlug, success and error when it failed. For a single article, use Publish, Unpublish, Unschedule or delete by slug.

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:
publish,
unpublish,
unschedule,
delete
teamId
string
provider
enum<string>

Connected CMS to publish to.

Available options:
wordpress,
shopify,
webflow,
ghost,
webhook,
framer,
grigora,
snowcms,
embed
status
enum<string>

Post status on the CMS. Defaults to publish.

Available options:
draft,
publish

Response

Default Response

eligibility
object