Bulk Actions

Bulk actions let you email, edit, delete, or subscribe leads in bulk.

Lead filtering

To initiate bulk actions for a subset of leads, provide the structured filtering values from the Advanced Filtering API such as query, results_limit, and sort fields. The only difference is that Bulk Actions endpoints require you to rename the query field to s_query (shorthand for structured query).

For example, this is the payload you would send to the Advanced Filtering API:

{
    "query": {
        "queries": [...]
    },
    "results_limit": 100,
    "sort": [{...}]
}

And this is the equivalent Bulk Actions payload (note query -> s_query):

{
    "s_query": {
        "queries": [...]
    },
    "results_limit": 100,
    "sort": [{...}]
}

Pausing and resuming

You can pause an in-progress bulk action by sending { "status": "paused" }. You can resume it afterwards with { "status": "resuming" }, unless more than 7 days have passed since you paused the action.

Receiving an email when done

By default a confirmation email is sent when a bulk action completes. Set "send_done_email": false in the request if you don’t want this.