Add a subscriber
buttondown_add_subscriberWRITE: add ONE subscriber by e-mail address. No subscriber type is set, so Buttondown applies the newsletter's normal sign-up rules (double opt-in: the subscriber is typically created as unactivated and Buttondown e-mails THAT ONE address a confirmation message; opt-in is never bypassed, nor is the firewall). Only add people who asked to subscribe. Creating a subscriber (and its tags) can also start the newsletter's own automations, which may e-mail that one subscriber. An existing e-mail is left untouched (error, no overwrite). Optional tags (a tag that does not exist is created, which needs a plan with tags), a private note and metadata. Buttondown limits creation to 100 subscribers per day. POST /subscribers.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Tag names to apply. | |
| notes | No | Private note (never shown to the subscriber). | |
| metadata | No | Free-form key-value data stored on the subscriber. | |
| utm_medium | No | ||
| utm_source | No | ||
| referrer_url | No | Where the subscriber came from. | |
| utm_campaign | No | ||
| email_address | Yes | The new subscriber's e-mail address. They receive the confirmation e-mail. |