Update newsletter list OAuth Scope: newsletter_lists:write

PATCH

https://api.beehiiv.com/v2/publications/:publicationId/newsletter_lists/:newsletterListId

PATCH

/v2/publications/:publicationId/newsletter_lists/:newsletterListId

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"
}'

{
  "data": {
    "id": "nl_list_00000000-0000-0000-0000-000000000000",
    "name": "Weekly Digest",
    "slug": "weekly-digest",
    "status": "active",
    "auto_subscribe": false,
    "subscriber_count": 100,
    "created_at": 1672531200,
    "updated_at": 1672531200,
    "description": "A weekly digest of the best content.",
    "from_address": "[email protected]",
    "reply_to_address": "[email protected]",
    "sender_name": "list|by|brand",
    "headers": {
      "X-Campaign-Id": "weekly-digest"
    },
    "utm_source": "newsletter",
    "utm_medium": "email",
    "utm_campaign": "weekly-digest",
    "utm_params_enabled": true
  }
}

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

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

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:

email_settingsobjectOptional

The sending identity for posts sent to this list. Only the provided fields within this object will be updated.

headersmap from strings to optional stringsOptional

Custom email headers for posts sent to this list. When provided, this replaces all existing headers on the list. Merges with publication headers at send time, with this list’s values winning on a key collision. Set a value to null to suppress a header inherited from the publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden.

Custom email headers for posts sent to this list. When provided, this replaces all existing headers on the list. Merges with publication headers at send time, with this list's values winning on a key collision. Set a value to `null` to suppress a header inherited from the publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden.

utm_sourcestringOptional

The utm_source appended to links in posts sent to this list.

utm_mediumstringOptional

The utm_medium appended to links in posts sent to this list.

utm_campaignstringOptional

The utm_campaign appended to links in posts sent to this list.

utm_params_enabledbooleanOptional

Whether UTM parameters are appended to links in posts sent to this list. When left unset on the list, falls back to the publication.

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