> ## Documentation Index
> Fetch the complete documentation index at: https://docs.letterbucket.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Newsletter Public API V1

> Create, list, update and unsubscribe newsletter subscribers from external integrations.

Use the Newsletter Public API to create, list, update and unsubscribe newsletter subscribers
from external integrations. This reference covers the endpoints, authentication, response
formats, caching behavior and request limits.

<CardGroup cols={3}>
  <Card title="Base URL" icon="link">
    `app.letterbucket.com/api/v1/`
  </Card>

  <Card title="Authentication" icon="key">
    Bearer API key
  </Card>

  <Card title="Rate limited" icon="gauge">
    Per minute, hour and day
  </Card>
</CardGroup>

## What you can do

<CardGroup cols={2}>
  <Card title="Create subscribers" icon="user-plus" href="/api/subscribers/create">
    Add one subscriber, or up to 100 at once with bulk create.
  </Card>

  <Card title="List & retrieve" icon="list" href="/api/subscribers/list">
    Paginated listing with optional status filters.
  </Card>

  <Card title="Update subscribers" icon="pen" href="/api/subscribers/update">
    Change email, name or status.
  </Card>

  <Card title="Unsubscribe" icon="user-minus" href="/api/subscribers/delete">
    Set a subscriber to unsubscribed.
  </Card>
</CardGroup>

## Conventions

* All requests and responses use `application/json`.
* The newsletter context is resolved from the API key — you do not pass a newsletter ID.
* Subscriber IDs are UUIDs (for example `019756c2-...`).
