---
title: "Delete 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

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

## Path parameters

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

## Request body

_Required._

- `confirmation` (`viewer-groups-delete.confirmation`; string, required)
  - minLength 1; maxLength 200

## Example request

```json
{
  "confirmation": "string"
}
```

## Code samples

### cURL

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

### TypeScript

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

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 = { "confirmation": "string" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
    "groupName": "string",
    "memberCount": 0,
    "affectedTabs": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "key": "string",
        "label": "string"
      }
    ],
    "affectedReports": [],
    "confirmation": "string"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`viewer-groups-delete.response.200.data`; object, required)
  - `groupId` (`viewer-groups-delete.response.200.data.groupId`; string, required)
    - format `uuid`
  - `groupName` (`viewer-groups-delete.response.200.data.groupName`; string, required)
  - `memberCount` (`viewer-groups-delete.response.200.data.memberCount`; integer, required)
    - min 0
  - `affectedTabs` (`viewer-groups-delete.response.200.data.affectedTabs`; array<object>, required)
    - `id` (`viewer-groups-delete.response.200.data.affectedTabs.id`; string, required)
      - format `uuid`
    - `key` (`viewer-groups-delete.response.200.data.affectedTabs.key`; string, required)
    - `label` (`viewer-groups-delete.response.200.data.affectedTabs.label`; string, required)
  - `confirmation` (`viewer-groups-delete.response.200.data.confirmation`; string, required)
  - `affectedReports` (`viewer-groups-delete.response.200.data.affectedReports`; array<object>, optional)
    - default `[]`
    - `id` (`viewer-groups-delete.response.200.data.affectedReports.id`; string, required)
      - format `uuid`
    - `title` (`viewer-groups-delete.response.200.data.affectedReports.title`; string, required)
- `meta` (`viewer-groups-delete.response.200.meta`; object, optional)
  - `timestamp` (`viewer-groups-delete.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-delete.response.400.error`; object, required)
  - `code` (`viewer-groups-delete.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.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-delete.response.401.error`; object, required)
  - `code` (`viewer-groups-delete.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.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-delete.response.403.error`; object, required)
  - `code` (`viewer-groups-delete.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.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-delete.response.404.error`; object, required)
  - `code` (`viewer-groups-delete.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.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-delete.response.409.error`; object, required)
  - `code` (`viewer-groups-delete.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.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-delete.response.500.error`; object, required)
  - `code` (`viewer-groups-delete.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`viewer-groups-delete.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`viewer-groups-delete.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`viewer-groups-delete.response.500.error.traceId`; string, optional) — Unique ID for log correlation


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