Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

ENDPOINTS
GET /odis/v1/communities/:community_id/benefits
GET /odis/v1/benefits/:id
POST /odis/v1/communities/:community_id/benefits
PATCH /odis/v1/benefits/:id
DELETE /odis/v1/benefits/:id
POST /odis/v1/benefits/:id/archive
POST /odis/v1/benefits/:id/activate
POST /odis/v1/benefits/:id/assign_to_tiers

​
Overview

Community benefits are features or perks that can be assigned to membership tiers. Benefits help differentiate tiers and provide value to members at different subscription levels.

​
Authentication

All endpoints require authentication. Authorization levels:
  • Community Owner: Full access to their community’s benefits
  • Admin: Full access to all benefits

​
Benefit Object

{
  "id": 1,
  "name": "Early Access to Releases",
  "description": "Get first access to new bottle releases before general availability",
  "position": 1,
  "status": "active",
  "tier_ids": [1, 2],
  "tiers": [
    {
      "id": 1,
      "name": "Gold Member",
      "position": 1
    },
    {
      "id": 2,
      "name": "Platinum Member",
      "position": 2
    }
  ],
  "community": {
    "id": 1,
    "name": "Whisky Enthusiasts"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-11-14T08:20:00Z"
}

​
Benefit Status

  • active - Benefit is active and visible
  • archived - Benefit is archived and hidden

​
Tier Assignment

Benefits can be assigned to one or more membership tiers:
  • Benefits can be assigned to multiple tiers
  • Tiers can have multiple benefits
  • Assignment can be updated at any time
  • Removing all tier assignments effectively makes the benefit unassigned

​
Ordering

Benefits are ordered by position (ascending), then by creation date. Use the position field to control display order.