beehiiv Developer Documentation

Update a newsletter list belonging to a specific publication.

AuthorizationBearer

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

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

This endpoint expects an object.

namestringOptional

The name of the newsletter list.

descriptionstringOptional

A description of the newsletter list.

slugstringOptional

A unique slug for the newsletter list.

auto_subscribebooleanOptional

Whether new subscribers are automatically subscribed to this list.

statusenumOptional

The status of the newsletter list. Valid values are active and archived. Setting draft is not permitted.

Allowed values:

dataobject

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/newsletter_lists/nl_list_00000000-0000-0000-0000-000000000000 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Weekly Digest Updated",
>	"status": "active"
>	}'

1	{
2	"data": {
3	"id": "nl_list_00000000-0000-0000-0000-000000000000",
4	"name": "Weekly Digest",
5	"slug": "weekly-digest",
6	"status": "active",
7	"auto_subscribe": false,
8	"subscriber_count": 100,
9	"created_at": 1672531200,
10	"updated_at": 1672531200,
11	"description": "A weekly digest of the best content."
12	}
13	}