PerspectPerspectDocs
Go to Admin
View as Markdown

Newsletter

This reference is auto-generated from the mounted public Hono routes in perspectapiworkers. Admin and internal routes are excluded.

Base Path

/api/v2/sites/:siteName/newsletter

Endpoints

GET /api/v2/sites/:siteName/newsletter/campaigns

Get campaigns.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/campaigns

Campaigns action.

Path params: siteName

DELETE /api/v2/sites/:siteName/newsletter/campaigns/:id

Delete campaigns.

Path params: siteName, id

PATCH /api/v2/sites/:siteName/newsletter/campaigns/:id

Update campaigns.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/campaigns/:idOrSlug

Get campaigns.

Path params: siteName, idOrSlug

GET /api/v2/sites/:siteName/newsletter/confirm/:token

Get confirm.

Path params: siteName, token

GET /api/v2/sites/:siteName/newsletter/lists

Get lists.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/lists

Lists action.

Path params: siteName

DELETE /api/v2/sites/:siteName/newsletter/lists/:id

Delete lists.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/lists/:id

Get lists.

Path params: siteName, id

PATCH /api/v2/sites/:siteName/newsletter/lists/:id

Update lists.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/series

Get series.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/series

Series action.

Path params: siteName

DELETE /api/v2/sites/:siteName/newsletter/series/:id

Delete series.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/series/:id

Get series.

Path params: siteName, id

PATCH /api/v2/sites/:siteName/newsletter/series/:id

Update series.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/statistics

Get statistics.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/subscribe

Subscribe action.

Path params: siteName

GET /api/v2/sites/:siteName/newsletter/subscriptions

Get subscriptions.

Path params: siteName

DELETE /api/v2/sites/:siteName/newsletter/subscriptions/:id

Delete subscriptions.

Path params: siteName, id

GET /api/v2/sites/:siteName/newsletter/subscriptions/:id

Get subscriptions.

Path params: siteName, id

POST /api/v2/sites/:siteName/newsletter/subscriptions/:id/list-membership

List membership action.

Path params: siteName, id

POST /api/v2/sites/:siteName/newsletter/subscriptions/:id/status

Status action.

Path params: siteName, id

POST /api/v2/sites/:siteName/newsletter/subscriptions/bulk

Bulk action.

Path params: siteName

GET /api/v2/sites/:siteName/newsletter/subscriptions/by-email

Get by email.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/subscriptions/import

Import action.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/subscriptions/sync

Sync action.

Path params: siteName

POST /api/v2/sites/:siteName/newsletter/track/click/:token

Click action.

Path params: siteName, token

POST /api/v2/sites/:siteName/newsletter/track/open/:token

Open action.

Path params: siteName, token

POST /api/v2/sites/:siteName/newsletter/unsubscribe

Unsubscribe action.

Path params: siteName

Path Parameters

Parameter
siteName
id
idOrSlug
token

This page is generated from the actual public Hono route table. Do not edit it by hand.