> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.12.0/api-reference/style-guide-api/actions/delete-collection-deletecollection.md).

# Delete collection (deletecollection)

### Request

Use the shared HTTP API endpoint and request formats.

See [HTTP API Overview](/v6.12.0/api-reference/overview.md).

#### Parameters

| Parameter    | Type   | Required | Default            | Notes                                                                  |
| ------------ | ------ | -------- | ------------------ | ---------------------------------------------------------------------- |
| `cmd`        | string | Yes      | `style_guide`      | Command name.                                                          |
| `action`     | string | Yes      | `deletecollection` | Action name.                                                           |
| `lang`       | string | No       | `common`           | Language scope to delete the collection in (example: `en_US` or `en`). |
| `collection` | string | Yes      |                    | The name of the collection to be deleted.                              |

### Behavior

* Delets an existing collection in the target lang scope.
* Returns the deleted collection info in `result`.

### Response

Single result object containing deleted `collection` with it's `category` and `lang` .

See [Response schema](/v6.12.0/api-reference/style-guide-api/response-schema.md).

### Errors

See

* [Errors](/v6.12.0/api-reference/style-guide-api/errors.md#deletecollection-errors).
* [Validation & limits](/v6.12.0/api-reference/style-guide-api/validation-and-limits.md)

### Examples

{% tabs %}
{% tab title="Example (JSON body)" %}

<details>

<summary>Request URL (on-premises)</summary>

{% code overflow="wrap" %}

```
http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=deletecollection&lang=en_US&collection=A test-collection
```

{% endcode %}

</details>

<details>

<summary>Request URL (Cloud)</summary>

{% code overflow="wrap" %}

```
https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=deletecollection&lang=en_US&collection=A test-collection
```

{% endcode %}

</details>

<details>

<summary>Request CURL (on-premises)</summary>

{% code overflow="wrap" %}

```bash
curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=deletecollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection'
```

{% endcode %}

</details>

<details>

<summary>Request CURL (Cloud)</summary>

{% code overflow="wrap" %}

```bash
curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=deletecollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection'
```

{% endcode %}

</details>

***

<details>

<summary>Response</summary>

{% code overflow="wrap" %}

```json
{
    "message": "Collection deleted.",
    "result": [
        {
            "language": "en_US",
            "collection": "A test-collection",
            "category": "A_TEST-COLLECTION"
        }
    ]
}
```

{% endcode %}

</details>
{% endtab %}

{% tab title="Example (XML body)" %}

<details>

<summary>Request URL (on-premises)</summary>

{% code overflow="wrap" %}

```
http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=deletecollection&lang=en_US&collection=A test-collection&format=xml
```

{% endcode %}

</details>

<details>

<summary>Request URL (Cloud)</summary>

{% code overflow="wrap" %}

```
https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=deletecollection&lang=en_US&collection=A test-collection&format=xml
```

{% endcode %}

</details>

<details>

<summary>Request CURL (on-premises)</summary>

{% code overflow="wrap" %}

```bash
curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=deletecollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'format=xml'
```

{% endcode %}

</details>

<details>

<summary>Request CURL (Cloud)</summary>

{% code overflow="wrap" %}

```bash
curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=deletecollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'format=xml'
```

{% endcode %}

</details>

***

<details>

<summary>Response</summary>

{% code overflow="wrap" %}

```xml
<message>Collection deleted.</message>

<result>
	<category>
		<language>en_US</language>
		<collection>A test-collection</collection>
		<category>A_TEST-COLLECTION</category>
	</category>
</result>
```

{% endcode %}

</details>
{% endtab %}
{% endtabs %}