Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Communities::SpaceGroup

Update Space Group

Update a space group

put/communities/space_groups/{id}

Path parameters

idstring required

Request body

Example request

{
  "communities_space_group": {
    "communities_space_group": {
      "name": "General",
      "access": 0,
      "is_hidden": false
    }
  }
}

Response

OK

idinteger

Group ID

public_idstring nullable

Group public ID

community_idinteger

Community ID the space group belongs to

workspace_idinteger

Workspace ID the space group belongs to

namestring nullable

Name

descriptionstring nullable

Description

access'is_open' | 'is_private' | 'is_secret'

Access level

group_type'standard' | 'course'

Group type

current_pathstring nullable

Current Path

emojistring nullable

Emoji icon for the group

card_image_idinteger nullable

Card Image ID

auto_add_to_spacesboolean

Automatically add members to new Topics within this Group

approval_termsstring nullable

Approval Terms — if present, these terms are used to AI moderate posts and comments automatically

require_post_approvalsboolean nullable

Require approvals for posts in this Group?

require_post_approvals_overrideboolean nullable

Whether the group-level post approval setting overrides the community-level setting

require_comment_approvalsboolean nullable

Require approvals for comments in this Group?

require_comment_approvals_overrideboolean nullable

Whether the group-level comment approval setting overrides the community-level setting

is_hiddenboolean

Only show joined Topics — when enabled customers only see Topics in the sidebar they have joined

is_hidden_from_non_membersboolean

Hide from non-members — when enabled the group is not visible unless the customer belongs to one of its Topics

always_onboolean nullable

Always On

upgrade_urlstring nullable

Upgrade URL — directs non-customers to an action page to gain access to this group

sort_orderinteger nullable

Sort order within the community

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

Example response

{
  "id": 1,
  "public_id": "BcDeFg",
  "community_id": 1,
  "workspace_id": 42,
  "name": "General",
  "description": "General discussion group",
  "access": "is_open",
  "group_type": "standard",
  "current_path": "/general",
  "emoji": "💬",
  "card_image_id": null,
  "auto_add_to_spaces": false,
  "approval_terms": null,
  "require_post_approvals": false,
  "require_post_approvals_override": false,
  "require_comment_approvals": false,
  "require_comment_approvals_override": false,
  "is_hidden": false,
  "is_hidden_from_non_members": false,
  "always_on": null,
  "upgrade_url": null,
  "sort_order": 1,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}