---
title: "Update viewer groups"
---

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

Path: Sureshake API › entities

`PATCH /v2/entities/{entityId}/viewer-groups/{groupId}`

## Path parameters

- `entityId` (`viewer-groups-update.path.entityId`; string, required)
  - format `uuid`
- `groupId` (`viewer-groups-update.path.groupId`; string, required)
  - format `uuid`

## Request body

- `name` (`viewer-groups-update.name`; string, optional)
  - minLength 1; maxLength 120
- `platformRole` (`viewer-groups-update.platformRole`; string, optional)
  - one of `"investor"`, `"lender"`, `"buyer"`, `"advisor"`, `"founder"`, `"viewer"`, `"other"`

## Example request

```json
{
  "name": "string",
  "platformRole": "investor"
}
```

## Code samples

### cURL

```bash
curl --request PATCH \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/viewer-groups/<groupId>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "platformRole": "investor"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<entityId>/viewer-groups/<groupId>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'string', platformRole: 'investor'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/entities/<entityId>/viewer-groups/<groupId>"

payload = {
    "name": "string",
    "platformRole": "investor"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "name": "string",
    "platformRole": "investor",
    "memberCount": 0,
    "tabCount": 0,
    "reportCount": 0
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`viewer-groups-update.response.200.data`; object, required)
  - `id` (`viewer-groups-update.response.200.data.id`; string, required)
    - format `uuid`
  - `entityId` (`viewer-groups-update.response.200.data.entityId`; string, required)
    - format `uuid`
  - `name` (`viewer-groups-update.response.200.data.name`; string, required)
  - `platformRole` (`viewer-groups-update.response.200.data.platformRole`; string, required)
    - one of `"investor"`, `"lender"`, `"buyer"`, `"advisor"`, `"founder"`, `"viewer"`, `"other"`
  - `memberCount` (`viewer-groups-update.response.200.data.memberCount`; integer, required)
    - min 0
  - `tabCount` (`viewer-groups-update.response.200.data.tabCount`; integer, required)
    - min 0
  - `reportCount` (`viewer-groups-update.response.200.data.reportCount`; integer, optional)
    - min 0; default `0`
- `meta` (`viewer-groups-update.response.200.meta`; object, optional)
  - `timestamp` (`viewer-groups-update.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.400.error`; object, required)
  - `code` (`viewer-groups-update.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.401.error`; object, required)
  - `code` (`viewer-groups-update.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.403.error`; object, required)
  - `code` (`viewer-groups-update.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.404.error`; object, required)
  - `code` (`viewer-groups-update.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.409.error`; object, required)
  - `code` (`viewer-groups-update.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`viewer-groups-update.response.500.error`; object, required)
  - `code` (`viewer-groups-update.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-update.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-update.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-update.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/viewer-groups-update/index.md