Update newsletter list OAuth Scope: newsletter_lists:write
Update newsletter list OAuth Scope: newsletter_lists:write
PATCH
https://api.beehiiv.com/v2/publications/:publicationId/newsletter_lists/:newsletterListId
Update a newsletter list belonging to a specific publication.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
publicationIdstringRequired
format: "^(pub_[0-9a-fA-F\-]+)$"The prefixed ID of the publication object
newsletterListIdstringRequired
format: "^(nl_list_[0-9a-fA-F\-]+)$"The prefixed ID of the newsletter list object
Request
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:
Response
OK
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