Subscribers (admin API)
Admin routes of the subscribers module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.
GET /v1/admin/subscribers
Section titled “GET /v1/admin/subscribers”List newsletter subscribers
Parameters:
pagein query (number, min 1, optional).pageSizein query (number, min 1, optional).searchin query (string, max length 254, optional).sourcein query (string, max length 50, optional).statusin query ("confirmed","pending","unsubscribed", optional).
Responses:
200: Subscribers retrieved.
PATCH /v1/admin/subscribers/{id}
Section titled “PATCH /v1/admin/subscribers/{id}”Manually unsubscribe / re-activate a subscriber
Parameters:
idin path (string, required).
Request body: UpdateSubscriberDto.
Responses:
200: Updated.404: Subscriber not found.
Schemas
Section titled “Schemas”UpdateSubscriberDto
Section titled “UpdateSubscriberDto”unsubscribed(boolean, required).