Skip to main content

Subscriptions

Subscriptions let users receive email notifications when new feedback is submitted to a room or form.

All endpoints require authentication.

List subscriptions​

GET /api/subscriptions

Returns all active subscriptions for the authenticated user.

Subscribe​

POST /api/subscriptions/:type/:targetId
ParameterValues
:typeroom or form
:targetIdThe room or form ID
{
  "frequency": "daily",
  "minSentiment": "negative"
}

Frequency options: instant, daily, weekly

minSentiment — only notify for feedback at or below this sentiment threshold. Optional.

Check subscription status​

GET /api/subscriptions/:type/:targetId

Returns the current subscription for this target, or 404 if not subscribed.

Update subscription​

PATCH /api/subscriptions/:type/:targetId
{
  "frequency": "weekly"
}

Unsubscribe​

DELETE /api/subscriptions/:type/:targetId