Update newsletter list subscription
update_newsletter_list_subscriptionUpdate a newsletter list subscription's state, including unsubscribing a member. Requires confirmation and newsletter_lists:write for OAuth integrations.
Instructions
Update newsletter list subscription. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require newsletter_lists: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>",
"newsletter_list_id": "<newsletter_list_id>",
"newsletter_list_subscription_id": "<newsletter_list_subscription_id>"
},
"name": "update_newsletter_list_subscription"
}
}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. | |
| unsubscribe | No | Set to true to unsubscribe the subscription from this newsletter list. | |
| 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 | |
| newsletter_list_id | Yes | The prefixed ID of the newsletter list object | |
| newsletter_list_subscription_id | Yes | The prefixed ID of the newsletter list subscription object |