beehiiv Developer Documentation

curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/newsletter_lists/nl_list_00000000-0000-0000-0000-000000000000/subscriptions/by_subscription_id/sub_00000000-0000-0000-0000-000000000000 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "unsubscribe": true
}'

{
  "data": {
    "id": "nl_list_sub_00000000-0000-0000-0000-000000000000",
    "newsletter_list_id": "nl_list_00000000-0000-0000-0000-000000000000",
    "subscription_id": "sub_00000000-0000-0000-0000-000000000000",
    "status": "active",
    "created_at": 1672531200,
    "subscribed_at": 1672531200
  }
}

Currently in beta

Newsletter Lists is currently in beta, the API is subject to change.

Update a newsletter list subscription by subscription ID. An alternative to the update endpoint when you don’t have the newsletter list subscription ID. Accepts either a subscription_id or email to identify the subscription. Currently supports unsubscribing a subscription from a newsletter list.

<Note title="Currently in beta" icon="b"> Newsletter Lists is currently in beta, the API is subject to change. </Note> Update a newsletter list subscription by subscription ID. An alternative to the update endpoint when you don't have the newsletter list subscription ID. Accepts either a subscription_id or email to identify the subscription. Currently supports unsubscribing a subscription from a newsletter list.

Currently in beta

Authentication

Path parameters

Request

Response

Errors

Currently in beta