# ArchiveGroup

## Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as *mandatory*.

### Headers

```
PUT /api/ss/group/:id/archive HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
```

### Path

**id (*****string*****)**

Identifier for the Group.

Example:

```
PUT /api/ss/group/5e8017d2e1385f0c58e8f4f8/archive HTTP/1.1
```

## Example

The following example is a cURL request to archive a group.

### Request

Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' parameter.

{% code overflow="wrap" %}

```
curl -X PUT 'https://localhost:3000/api/ss/group/5e8017d2e1385f0c58e8f4f8/archive' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{}'
```

{% endcode %}

### Response

Response contains a status.

```
{
   "status": "ok"
}
```