v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

Lists

Update subscriber list

Updates a subscriber list's name, description, or privacy flag. Only provided fields are changed.

patch/lists/{listId}

Path parameters

listIdstring required

Subscriber list ID.

Request body

namestring

New list name.

descriptionstring nullable

New list description. Pass null to clear it.

isPrivateboolean

Set to true to keep the list internal and omit it from individual controls on the hosted subscriber email preferences/unsubscribe page. Set to false to expose its name and description on that page. List privacy does not override a subscriber's global unsubscribe. Omit this field to leave the current visibility unchanged.

Response

List updated

successboolean

Example response

{
  "success": true,
  "list": {
    "id": "list_abc123",
    "name": "Newsletter Subscribers"
  }
}