Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Bulk Actions

Create Bulk Action

Create a new bulk action

post/bulk_actions

Request body

type'add_notes' | 'apply_tags' | 'apply_metadata' | 'rename_metadata' | 'ban_subscribers' | 'delete_subscribers' | 'gift_subscribers' | 'ungift_subscribers' | 'reactivate_subscribers' | 'mark_subscribers_as_not_spammy' | 'resubscribe_subscribers' | 'send_emails' | 'unban_subscribers' | 'send_reminders' | 'unsubscribe_subscribers' | 'delete_attachments' | 'delete_emails' | 'delete_images' | 'update_email_types' | 'update_archival_modes' | 'update_commenting_modes' | 'mark_inbox_items_read' | 'delete_inbox_items' | 'change_tags_colors' | 'delete_comments' | 'delete_surveys' | 'delete_survey_responses' | 'delete_tags' | 'mark_comments_as_active' | 'mark_comments_as_spammy' | 'replay_events' | 'update_survey_statuses' | 'cancel_stripe_subscriptions' | 'modify_stripe_subscriptions' | 'pause_stripe_subscriptions' required

Represents the action being performed on a bulk of objects.

(Not to be coy, but these names should be self-explanatory.)

metadataobject required

Parameters for the bulk action. The exact shape depends on type — typically an ids list of object IDs to act on.

Example request

{
  "metadata": {
    "ids": [
      "611c8825-6f21-4544-bb47-9f50453e9cb0",
      "418c701a-efe3-4e3d-a404-e635a2f28775"
    ]
  }
}

Response

Created

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

type'add_notes' | 'apply_tags' | 'apply_metadata' | 'rename_metadata' | 'ban_subscribers' | 'delete_subscribers' | 'gift_subscribers' | 'ungift_subscribers' | 'reactivate_subscribers' | 'mark_subscribers_as_not_spammy' | 'resubscribe_subscribers' | 'send_emails' | 'unban_subscribers' | 'send_reminders' | 'unsubscribe_subscribers' | 'delete_attachments' | 'delete_emails' | 'delete_images' | 'update_email_types' | 'update_archival_modes' | 'update_commenting_modes' | 'mark_inbox_items_read' | 'delete_inbox_items' | 'change_tags_colors' | 'delete_comments' | 'delete_surveys' | 'delete_survey_responses' | 'delete_tags' | 'mark_comments_as_active' | 'mark_comments_as_spammy' | 'replay_events' | 'update_survey_statuses' | 'cancel_stripe_subscriptions' | 'modify_stripe_subscriptions' | 'pause_stripe_subscriptions' required

Represents the action being performed on a bulk of objects.

(Not to be coy, but these names should be self-explanatory.)

metadataobject required

Parameters for the bulk action. The exact shape depends on type — typically an ids list of object IDs to act on.

status'not_started' | 'in_progress' | 'processed' | 'failed' required

Represents the status of a bulk action.

No action is required to move from one state or another; Buttondown internally handles the transitions, and exposing the status is for observability purposes only.

completion_datestring date-time nullable

The date and time at which the bulk action was completed.

Example response

{
  "metadata": {
    "ids": [
      "611c8825-6f21-4544-bb47-9f50453e9cb0",
      "418c701a-efe3-4e3d-a404-e635a2f28775"
    ]
  }
}