Update CommunityGroup

PUT

api

community

communitygroups

curl --request PUT \
  --url https://spaces.nexudus.com/api/community/communitygroups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "UserId": 123,
  "Name": "<string>",
  "GroupAccess": 123
}
'

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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>"
    }
  ]
}

Updates an existing CommunityGroup record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

eCommunityThreadVisibility — GroupAccess values

Value	Name
1	Restricted
2	Public
3	Private

Request Body

Required Fields

integer

required

The Id of the CommunityGroup record to update.

integer

required

ID of the location this community group belongs to.

integer

required

ID of the user account that administers this group; the administrator can always view and post in it.

string

required

Required display name of the community group.

integer

required

Access level for conversations assigned to this group: Restricted (1) lets all customers view but only the administrator and members post; Public (2) lets all customers view and post; Private (3) lets only the administrator and members view and post.

Optional Fields

string

Optional description of the community group’s purpose shown to customers.

integer[]

List of user IDs whose customers are group members; they can post in Restricted groups and view and post in Private groups, while the administrator always has access.

integer[]

IDs added to the Members relationship..

integer[]

IDs removed from the Members relationship..

string

Internal GUID linking this automatically maintained group to its Team; change Team.HasCommunityGroup instead.

string

Internal GUID linking this automatically maintained group to its Course; change Course.HasCommunityGroup instead.

Code Examples

curl -X PUT \
  "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,
    "Id": 87654321
}'

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

const data = await response.json();

import requests

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

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the communitygroup was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CommunityGroup was successfully updated.",
  "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 CommunityGroup

curl --request PUT \
  --url https://spaces.nexudus.com/api/community/communitygroups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "UserId": 123,
  "Name": "<string>",
  "GroupAccess": 123
}
'

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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