Skip to content

Creates a space group to hold spaces in the sidebar.

title and slug are both required and must be unique across all space records, groups and spaces alike. The group is appended to the end of the sidebar order.

Endpoint

  • Method: POST

  • Path: /spaces/space_groups

  • Edition: Core

  • Controller: SpaceController@createSpaceGroup

  • Route source: fluent-community/app/Http/Routes/api.php:33

  • Controller source: fluent-community/app/Http/Controllers/SpaceController.php

  • Requires community-admin or course-admin access, or the admin role in the space named by space_id.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

POST Create Space Group

POST
/spaces/space_groups

Creates a space group to hold spaces in the sidebar.

Controller: SpaceController@createSpaceGroup
Route source: fluent-community/app/Http/Routes/api.php:33

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
  
"always_show_spaces": "string"
  
},
  
"title": "string",
  
"slug": "string"
}

Responses

Successful response

application/json
JSON
{
  
"group": {
  
  
"created_at": "string",
  
  
"created_by": 0,
  
  
"description": "string",
  
  
"id": 0,
  
  
"serial": 0,
  
  
"settings": {
  
  
  
"always_show_spaces": "string",
  
  
  
"hide_members": "string"
  
  
},
  
  
"slug": "string",
  
  
"status": "string",
  
  
"title": "string",
  
  
"type": "string",
  
  
"updated_at": "string"
  
},
  
"message": "string"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation