Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

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.

List newsletter subscribers

Parameters:

  • page in query (number, min 1, optional).
  • pageSize in query (number, min 1, optional).
  • search in query (string, max length 254, optional).
  • source in query (string, max length 50, optional).
  • status in query ("confirmed", "pending", "unsubscribed", optional).

Responses:

  • 200: Subscribers retrieved.

Manually unsubscribe / re-activate a subscriber

Parameters:

  • id in path (string, required).

Request body: UpdateSubscriberDto.

Responses:

  • 200: Updated.
  • 404: Subscriber not found.
  • unsubscribed (boolean, required).
As seen on Open Source Alternatives The Merchant Engine badge