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,
    "unsubscribed_at": null
  }
}

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

newsletterListIdstringRequiredformat: "^(nl_list_[0-9a-fA-F\-]+)$"

The prefixed ID of the newsletter list object

subscriptionIdstringRequiredformat: "^(sub_[0-9a-fA-F\-]+)$"

The prefixed ID of the subscription

Request

This endpoint expects an object.

unsubscribebooleanOptional

Set to true to unsubscribe the subscription from this newsletter list.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error