Skip to main content
POST
/
api
/
community
/
communitygroups
Create CommunityGroup
curl --request POST \
  --url https://spaces.nexudus.com/api/community/communitygroups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "UserId": 123,
  "Name": "<string>",
  "GroupAccess": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A CommunityGroup is a named subset of customers used to control who can see and contribute to conversations on the Discussion Board. Groups are created by admins and can be assigned to CommunityThread conversations to restrict or open participation. Each group has an access level (GroupAccess) that determines visibility:
ValueMeaning
Restricted (1)All customers can see the group’s conversations but only members can post
Public (2)Any customer with access to Discussion Boards can see and post
Private (3)Only group members can see or post in the group’s conversations
Groups can also be auto-generated by the system: if a Team has HasCommunityGroup = true, a group is created and its GUID stored in TeamGuid; if a Course has HasCommunityGroup = true, a group is created and its GUID stored in CourseGuid.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CommunityGroup-Create role.

​
Enums

ValueName
1Restricted
2Public
3Private

​
Request Body

​
Required Fields

​
BusinessId
integer
required
ID of the location this group belongs to.
​
UserId
integer
required
ID of the user account designated as the group administrator.
​
Name
string
required
Display name of the group.
​
GroupAccess
integer
required
Access level controlling who can see and post in this group’s conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only.

​
Optional Fields

​
Description
string
Short description of the group’s purpose shown to customers.
​
Members
integer[]
IDs of customers who are members of this group.
​
TeamGuid
string
GUID of the Team this group was created for. Set when the group was auto-generated because Team.HasCommunityGroup is true.
​
CourseGuid
string
GUID of the Course this group was created for. Set when the group was auto-generated because Course.HasCommunityGroup is true.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/community/communitygroups" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "UserId": 0,
    "Name": "",
    "GroupAccess": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the communitygroup was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CommunityGroup was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}