Sequenzy Lists API
The Lists API from Sequenzy — 4 operation(s) for lists.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sequenzy:sequenzy-lists-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Sequenzy Lists API
description: Sequenzy API for managing subscribers, tags, events, sequences, and transactional emails
version: 1.0.0
servers:
- url: https://api.sequenzy.com/api/v1
description: Production server
- url: https://api.sequenzy.com/v1
description: Legacy production server alias
security:
- bearerAuth: []
tags:
- name: Lists
paths:
/lists:
get:
operationId: listSubscriberLists
summary: List subscriber lists
description: Lists subscriber lists for the authenticated company. Each list includes subscriberCount (current members of any status) and activeSubscriberCount (current members with status=active). Members who unsubscribed from the list are not counted.
tags:
- Lists
responses:
'200':
description: Lists returned
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
lists:
type: array
items:
$ref: '#/components/schemas/SubscriberList'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
post:
operationId: createSubscriberList
summary: Create subscriber list
description: Creates a subscriber list for grouping contacts.
tags:
- Lists
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
name:
type: string
description:
type: string
description: Optional internal workspace metadata. Never shown in hosted or embedded subscriber preferences.
isPrivate:
type: boolean
description: 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.
allowMemberUnsubscribe:
type: boolean
description: 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.
required:
- name
responses:
'200':
description: List created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
list:
$ref: '#/components/schemas/SubscriberList'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: List could not be created
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/lists/{listId}/subscribers:
post:
operationId: addSubscribersToList
summary: Add subscribers to list
description: Adds existing or new subscribers to one subscriber list from an email array. Use this endpoint without a `/bulk` suffix. Requires the lists:write and subscribers:write scopes.
tags:
- Lists
parameters:
- name: listId
in: path
required: true
schema:
type: string
description: Subscriber list ID.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
emails:
type: array
maxItems: 500
items:
type: string
format: email
description: Up to 500 email addresses per request.
duplicateStrategy:
type: string
enum:
- skip
- merge
- overwrite
default: skip
enrollInSequences:
type: boolean
default: false
optInMode:
type: string
enum:
- default
- confirmed
- double_opt_in
default: default
required:
- emails
responses:
'200':
description: Subscribers processed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
listId:
type: string
total:
type: integer
processed:
type: integer
created:
type: integer
updated:
type: integer
skipped:
type: integer
addedToList:
type: integer
failed:
type: integer
duplicateInputCount:
type: integer
ignoredBlankCount:
type: integer
results:
type: array
items:
type: object
properties:
email:
type: string
success:
type: boolean
created:
type: boolean
updated:
type: boolean
skipped:
type: boolean
addedToList:
type: boolean
error:
type: string
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: List not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Subscribers could not be added
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/lists/{listId}:
patch:
operationId: updateSubscriberList
summary: Update subscriber list
description: Updates a subscriber list's name, description, or privacy flag. Only provided fields are changed.
tags:
- Lists
parameters:
- name: listId
in: path
required: true
schema:
type: string
description: Subscriber list ID.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
name:
type: string
minLength: 1
description: New list name.
description:
type:
- string
- 'null'
description: New internal list description. Never shown in hosted or embedded subscriber preferences. Pass null to clear it.
isPrivate:
type: boolean
description: 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.
allowMemberUnsubscribe:
type: boolean
description: 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.
responses:
'200':
description: List updated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
list:
$ref: '#/components/schemas/SubscriberList'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: List not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: List could not be updated
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteSubscriberList
summary: Delete subscriber list
description: Deletes a subscriber list and removes all list memberships. Subscribers themselves are not deleted.
tags:
- Lists
parameters:
- name: listId
in: path
required: true
schema:
type: string
description: Subscriber list ID.
responses:
'200':
description: List deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
removedMemberships:
type: integer
description: Number of list memberships removed.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: List not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
$ref: '#/components/responses/TransientDatabaseUnavailable'
/lists/{listId}/subscribers/remove:
post:
operationId: removeSubscribersFromList
summary: Remove subscribers from list
description: Removes subscribers from one subscriber list by email or subscriber ID. Subscribers themselves are not deleted. Requires the lists:write and subscribers:write scopes, the same as adding them.
tags:
- Lists
parameters:
- name: listId
in: path
required: true
schema:
type: string
description: Subscriber list ID.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
emails:
type: array
items:
type: string
format: email
description: Email addresses to remove. Combined with subscriberIds, up to 500 per request.
subscriberIds:
type: array
items:
type: string
description: Subscriber IDs to remove. Combined with emails, up to 500 per request.
responses:
'200':
description: Subscribers removed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
removed:
type: integer
description: Number of list memberships removed.
notFound:
type: array
items:
type: string
description: Emails that did not match any subscriber.
'400':
description: No targets provided or too many targets
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: List not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
headers:
RetryAfter:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
minimum: 1
example: 1
responses:
TransientDatabaseUnavailable:
description: The database was temporarily unavailable. The request may be retried after the delay in Retry-After.
headers:
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
error: The service could not reach its database for a moment. Retry the request.
code: SERVICE_UNAVAILABLE
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
code:
type: string
description: Optional stable machine-readable error discriminator when available.
example: COMPANY_CREATE_REQUIRES_PERSONAL_KEY
retryable:
type: boolean
description: Whether retrying the request can recover from the error.
issues:
type: array
description: Field-level problems with the request, when the endpoint reports them. Up to ten entries; `error` summarizes the first three.
items:
$ref: '#/components/schemas/InputIssue'
required:
- error
SubscriberList:
type: object
properties:
id:
type: string
example: list_abc123
name:
type: string
example: Newsletter Subscribers
description:
type:
- string
- 'null'
description: Internal workspace metadata returned only through authenticated list-management surfaces. Never shown in hosted or embedded subscriber preferences.
isPrivate:
type: boolean
description: Whether the list is private. Private lists are hidden unless allowMemberUnsubscribe is enabled, in which case current members can see the name and opt out. Private lists cannot be joined through preferences. Descriptions remain internal; global unsubscribe still applies.
example: false
allowMemberUnsubscribe:
type: boolean
default: false
description: Whether current members of a private list can see its name and unsubscribe in preferences. Does not allow joining or rejoining. No effect on public lists.
createdAt:
type: string
format: date-time
subscriberCount:
type: integer
description: Current list members of any status. Memberships with unsubscribedAt set are excluded.
activeSubscriberCount:
type: integer
description: Current list members with status=active. May include phone-only contacts without an email address.
InputIssue:
type: object
properties:
path:
type: string
description: Dotted field path, such as `audience.subscriberIds[0]`. Empty when the problem is with the request body itself.
example: kind
message:
type: string
description: What is wrong with the field.
example: must be "add_tags"
allowedValues:
type: array
description: Accepted values when the field only takes a fixed set of values.
items: {}
example:
- add_tags
required:
- path
- message
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key passed as Bearer token