Create newsletter list subscriber import
newsletter_list_subscriptions_create_importImport subscribers into a Beehiiv newsletter list by tag or boolean custom field. Set confirm=true to change account state; OAuth needs newsletter_lists:write.
Instructions
Create newsletter list subscriber import. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require newsletter_lists:write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | The name of a subscriber tag. Only subscribers with this tag are added. Cannot be combined with `custom_field_id`. | |
| 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 | |
| custom_field_id | No | The ID of a boolean custom field. Only subscribers with this field set to `true` are added. Cannot be combined with `tag`. | |
| newsletter_list_id | Yes | The prefixed ID of the newsletter list object |