Represents the action being performed on a bulk of objects.
(Not to be coy, but these names should be self-explanatory.)
Apply tags
Type
apply_tags
Description
This action requires two additional parameters within `metadata`: `tag_id` (the ID of the tag which you'd like to either add or remove to the list of subscribers) and `action` (which can be either `add` or `remove`).
Apply metadata (to subscribers)
Type
apply_metadata
Description
This action requires two additional parameters within `metadata`: `action` (which can be either `add`, `set`, or `remove`), and `metadata` (the value of the metadata which you'd like to either add or remove to the list of subscribers).
Ban subscribers
Type
ban_subscribers
Description
Ban subscribers from your newsletter.
Delete emails
Type
delete_emails
Description
Delete multiple emails in bulk.
Delete comments
Type
delete_comments
Description
Delete multiple comments in bulk.
Delete subscribers
Type
delete_subscribers
Description
Delete multiple subscribers in bulk.
Delete surveys
Type
delete_surveys
Description
Delete multiple surveys in bulk.
Delete tags
Type
delete_tags
Description
Delete multiple tags in bulk.
Gift subscribers
Type
gift_subscribers
Description
Gift premium subscriptions to multiple subscribers in bulk.
Mark subscribers as not spammy
Type
mark_subscribers_as_not_spammy
Description
Restore the status of multiple subscribers. Their exact type will depend on their history with your newsletter, but in general Buttondown will do the 'right' thing (e.g. restoring their premium subscription if they had one.)
Reactivate subscribers
Type
reactivate_subscribers
Description
Reactivate multiple subscribers in bulk.
Replay events
Type
replay_events
Description
Replay multiple events in bulk.
Resubscribe subscribers
Type
resubscribe_subscribers
Description
Resubscribe multiple unsubscribed subscribers in bulk.
Send emails
Type
send_emails
Description
This action requires one additional parameter within `metadata`: `email_id` (the ID of the email which you'd like to send).
Send reminders
Type
send_reminders
Description
Send reminders to multiple subscribers in bulk.
Update email types
Type
update_email_types
Description
Update the email types for multiple emails in bulk.
Unsubscribe subscribers
Type
unsubscribe_subscribers
Description
Unsubscribe multiple subscribers in bulk.
Update status types
Type
update_survey_statuses
Description
Update the status types for multiple surveys in bulk.
Update commenting modes
Type
update_commenting_modes
Description
Update the commenting modes for multiple emails in bulk.
Update archival modes
Type
update_archival_modes
Description
Update the archival modes for multiple emails in bulk.
Ungift subscribers
Type
ungift_subscribers
Description
Remove gifted premium subscriptions from multiple subscribers in bulk.