HomeTutorialsAPI ReferenceStatus
API Reference

Execute Bulk Action

post
https://{APP_DOMAIN}/api/3.2/subscriptions/bulk-actions

Executes a bulk action on subscriptions matching an advanced query. Runs as a background task. Supported actions: subscriber_add_tag, subscriber_remove_tag, subscription_add_tag, subscription_remove_tag, subscribe, cancel, add_to_funnel, remove_from_funnel, create_segment, add_to_segment.

Body Params

Body Params

string
required

JSON string of the advanced query to match subscriptions

string
enum
required

The action to perform

bulk_action_tag_ids
array of integers

Tag IDs (for tag actions)

bulk_action_tag_ids
integer

Funnel ID (for funnel actions)

integer

Segment ID (for add_to_segment)

string

Name (for create_segment)

string

Segment type: static or dynamic (for create_segment)

integer

Publication ID (for subscribe/create_segment)

Response
202

The bulk action has been started. Returns a task ID for tracking progress.

Updated 22 days ago

Language
Credentials
Bearer
JWT
URL
Updated 22 days ago