Lists

Remove subscribers from list

Changed on

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.

post/lists/{listId}/subscribers/remove

Request

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

Path parameters

listIdstring required

Subscriber list ID.

Request body

emailsstring[]

Email addresses to remove. Combined with subscriberIds, up to 500 per request.

subscriberIdsstring[]

Subscriber IDs to remove. Combined with emails, up to 500 per request.

Response

Subscribers removed

successboolean
removedinteger

Number of list memberships removed.

notFoundstring[]

Emails that did not match any subscriber.

Example response

{
  "success": true
}

Changes

  • db3873ca3d4dRevision changes
    • 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

  • ba3a29c6eb33Revision changes
    • 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