Create newsletter list subscription
create_newsletter_list_subscriptionSubscribe an email address or existing subscription to a Beehiiv newsletter list. Requires confirm=true for the action and newsletter_lists:write for OAuth.
Instructions
Create newsletter list subscription. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require newsletter_lists:write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | The email address of the subscription to subscribe. Either subscription_id or email must be provided. | ||
| 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 | |
| subscription_id | No | The prefixed ID of the subscription to subscribe. Either subscription_id or email must be provided. | |
| newsletter_list_id | Yes | The prefixed ID of the newsletter list object |