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

integer[]

Customer IDs to add as members (used in partial updates).

integer[]

Customer IDs to remove as members (used in partial updates).

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

Delete CommunityGroupDelete an existing CommunityGroup record by its Id.

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