Buttondown Documentation
Represents the action being performed on a bulk of objects.
(Not to be coy, but these names should be self-explanatory.)
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
).
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 from your newsletter.
Delete multiple emails in bulk.
Delete multiple comments in bulk.
Delete multiple subscribers in bulk.
Delete multiple surveys in bulk.
Delete multiple survey responses in bulk.
Delete multiple tags in bulk.
Gift premium subscriptions to multiple subscribers in bulk.
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 multiple subscribers in bulk.
Replay multiple events in bulk.
Resubscribe multiple unsubscribed subscribers in bulk.
This action requires one additional parameter within metadata
: email_id
(the ID of the email which you'd like to send).
Send reminders to multiple subscribers in bulk.
Update the email types for multiple emails in bulk.
Unsubscribe multiple subscribers in bulk.
Update the status types for multiple surveys in bulk.
Update the commenting modes for multiple emails in bulk.
Update the archival modes for multiple emails in bulk.
Remove gifted premium subscriptions from multiple subscribers in bulk.