Lists

Create subscriber list

Changed on

Creates a subscriber list for grouping contacts.

post/lists

Request

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

Request body

namestring required
descriptionstring

Optional internal workspace metadata. Never shown in hosted or embedded subscriber preferences.

isPrivateboolean

Set to true to hide the list from subscriber preferences unless allowMemberUnsubscribe is enabled for current members. Public lists expose only their name on that page; descriptions remain internal. List privacy does not override a subscriber's global unsubscribe. Defaults to false when omitted.

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 created

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

  • 27da5fc252a3Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status