Create data deletion request
create_data_deletionSubmit a subscriber data deletion request for a Beehiiv publication. Requires publication_id, confirm=true for user-requested actions, and data_deletion:write for OAuth.
Instructions
Create data deletion request. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require data_deletion:write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | The email address of the subscriber to delete. | ||
| 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. | |
| 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 |