Create CommunityGroup

POST

api

community

communitygroups

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
}
'

import requests

url = "https://spaces.nexudus.com/api/community/communitygroups"

payload = {
    "BusinessId": 123,
    "UserId": 123,
    "Name": "<string>",
    "GroupAccess": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, UserId: 123, Name: '<string>', GroupAccess: 123})
};

fetch('https://spaces.nexudus.com/api/community/communitygroups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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:

Value	Meaning
`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

eCommunityThreadVisibility — GroupAccess values

Value	Name
1	Restricted
2	Public
3	Private

Request Body

Required Fields

integer

required

ID of the location this group belongs to.

integer

required

ID of the user account designated as the group administrator.

string

required

Display name of the group.

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

string

Short description of the group’s purpose shown to customers.

integer[]

IDs of customers who are members of this group.

string

GUID of the Team this group was created for. Set when the group was auto-generated because Team.HasCommunityGroup is true.

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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/community/communitygroups',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      UserId: 0,
      Name: '',
      GroupAccess: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/community/communitygroups',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'UserId': 0,
        'Name': '',
        'GroupAccess': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the communitygroup was created successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update CommunityGroupUpdate an existing CommunityGroup record.

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
}
'

import requests

url = "https://spaces.nexudus.com/api/community/communitygroups"

payload = {
    "BusinessId": 123,
    "UserId": 123,
    "Name": "<string>",
    "GroupAccess": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, UserId: 123, Name: '<string>', GroupAccess: 123})
};

fetch('https://spaces.nexudus.com/api/community/communitygroups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400