Merge pull request #23 from ezio416/patch-1

Update activities.md
openplanet-nl · Sep 28, 2024 · ff3b745 · ff3b745
2 parents 39c8c1d + 77e04bf
commit ff3b745
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/live/clubs/activities.md b/docs/live/clubs/activities.md
@@ -25,8 +25,8 @@ parameters:
       required: true
     - name: active
       type: Boolean
-      description: Whether to only include currently active entries
-      required: true
+      description: Optional filter for enabled/disabled activities
+      required: false
 ---
 
 Gets a list of club activities, including news, rooms, campaigns and others.
@@ -35,7 +35,7 @@ Gets a list of club activities, including news, rooms, campaigns and others.
 
 **Remarks**:
 
-- For clubs you are not an admin of, `active` needs to be set to `true` because only admins are allowed to see disabled activities. Otherwise you'll get an error complaining that you're not a member/admin of the club.
+- Omitting the `active` parameter implicitly requests both enabled and disabled activities. For clubs you are not an admin of, `active` needs to be explicitly set to `true` because only admins are allowed to see disabled activities - otherwise you'll get an error complaining that you're not a member/admin of the club.
 - As of 2024-01-17, this endpoint's response links to `.dds` media files by default, while several scaled `.png` versions are available using separate fields (see example below for reference).
 
 ---