Lists

Update subscriber list

Changed on

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

patch/lists/{listId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/lists/{listId}
  • Auth
    HTTP bearer

Path parameters

listIdstring required

Subscriber list ID.

Request body

namestring

New list name.

descriptionstring nullable

New internal list description. Never shown in hosted or embedded subscriber preferences. Pass null to clear it.

isPrivateboolean

Set to true to hide the list from subscriber preferences unless allowMemberUnsubscribe is enabled for current members. Set to false to expose only its name on that page; descriptions remain internal. List privacy does not override a subscriber's global unsubscribe. Omit this field to leave the current visibility unchanged.

allowMemberUnsubscribeboolean

Allow current private-list members to see its name and opt out in preferences. Defaults false on create; omission preserves on update and false disables. Null is rejected. Stored but has no effect on public lists. Does not permit private joining or rejoining.

Response

List updated

successboolean

Example response

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

Changes

  • db3873ca3d4dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable