Skip to content

Updates a space addressed by numeric id; the id is resolved to a slug and then handled exactly as the by-slug endpoint.

Endpoint

  • Method: PUT

  • Path: /spaces/{spaceId}/by-id

  • Edition: Core

  • Controller: SpaceController@patchById

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

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

  • Requires community-admin access or the admin role in this space.

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.

PUT Update Space By ID

PUT
/spaces/{spaceId}/by-id

Updates a space addressed by numeric id; the id is resolved to a slug and then handled exactly as the by-slug endpoint.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

spaceId*

SpaceId extracted from the URL path.

Type
integer
Required

Request Body

application/json
JSON
{
  
"data": {
  
  
"privacy": "string",
  
  
"settings": {
  
  
  
"can_create_post": "string",
  
  
  
"custom_lock_screen": "string",
  
  
  
"document_access": "string",
  
  
  
"document_library": "string",
  
  
  
"emoji": "string",
  
  
  
"hide_members_count": "string",
  
  
  
"layout_style": "string",
  
  
  
"media_access": "string",
  
  
  
"media_gallery": "string",
  
  
  
"restricted_post_only": "string",
  
  
  
"shape_svg": "string"
  
  
},
  
  
"title": "string"
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"redirect_url": "string"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation