beehiiv Developer Documentation

Currently in beta

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

Update a newsletter list belonging to a specific publication.

<Note title="Currently in beta" icon="b"> Newsletter Lists is currently in beta, the API is subject to change. </Note> Update a newsletter list belonging to a specific publication.

$	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	}

Currently in beta

Authentication

Path parameters

Request

Response

Errors

Currently in beta