Update subscriptions' status
bulk_subscription_updates_put_statusChange subscription statuses in bulk for a Beehiiv publication. Provide subscription IDs and the new status; confirm=true is required to execute.
Instructions
Update subscriptions' status. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require subscriptions:write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file. | |
| new_status | No | The new status to set for the subscriptions | |
| payload_file | No | Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged. | |
| publication_id | Yes | The prefixed ID of the publication object | |
| subscription_ids | No | An array of subscription IDs to be updated |