> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update CommunityGroup

> Update an existing CommunityGroup record.

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

## Authentication

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

## Enums

<Accordion title="eCommunityThreadVisibility — GroupAccess values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Restricted |
  | 2     | Public     |
  | 3     | Private    |
</Accordion>

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the CommunityGroup record to update.
</ParamField>

<ParamField body="BusinessId" type="integer" required>
  ID of the location this group belongs to.
</ParamField>

<ParamField body="UserId" type="integer" required>
  ID of the user account designated as the group administrator.
</ParamField>

<ParamField body="Name" type="string" required>
  Display name of the group.
</ParamField>

<ParamField body="GroupAccess" type="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.
</ParamField>

### Optional Fields

<ParamField body="Description" type="string">
  Short description of the group's purpose shown to customers.
</ParamField>

<ParamField body="Members" type="integer[]">
  IDs of customers who are members of this group.
</ParamField>

<ParamField body="AddedMembers" type="integer[]">
  Customer IDs to add as members (used in partial updates).
</ParamField>

<ParamField body="RemovedMembers" type="integer[]">
  Customer IDs to remove as members (used in partial updates).
</ParamField>

<ParamField body="TeamGuid" type="string">
  GUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ParamField>

<ParamField body="CourseGuid" type="string">
  GUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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
  }'
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitygroup was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```