Buttondown Documentation

Buttondown Documentation

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook

Introduction

A bulk action represents, well, a bulk action. It is used to perform actions on a large number of objects at once. For example, you can use it to delete a large number of emails, or to unsubscribe a large number of subscribers. The actions within a bulk action are processed serially by Buttondown; this should be considered an ergonomic way to batch API calls across the network rather than a net-new piece of functionality in of itself.

{
    "creation_date": "2019-08-24T14:15:22Z",
    "completion_date": "2019-08-24T14:17:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "completed",
    "type": "delete_subscribers",
    "metadata": {
        "ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
    }
}

Fields

type

Type
BulkActionType

metadata

Type
object

id

Type
string
Description
A unique UUID associated with the object.

creation_date

Type
string
Description
The date and time at which the object was created.

status

Type
BulkActionStatus

completion_date

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

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook