Create subscription export
create_exportCreate a subscription export for a Beehiiv publication, optionally scoped to a segment and with full or basic columns. Set confirm=true to run this account-changing action.
Instructions
Create subscription export. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require subscriptions:write.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"publication_id": "<publication_id>"
},
"name": "create_export"
}
}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. | |
| variant | No | Which column set the export uses | |
| segment_id | No | ||
| 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 |