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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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)

Responses

422

Validation failed (e.g. missing advanced_query, invalid bulk_action_type, or required action-specific param missing).

Updated 10 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 days ago