Delete a collection

Request

You can delete a single collection by making a DELETE request to https://api.intercom.io/help_center/collections/<id>.

Requires the read_write_articles_scope OAuth scope. Set Intercom-Version: Preview.

Security

bearerAuth

Path

idintegerrequired

The unique identifier for the collection which is given by Intercom.

Example:123

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X DELETE \
  https://api.intercom.io/help_center/collections/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

successful

Bodyapplication/json

idstring

The unique identifier for the collection which you provided in the URL.

Example:"6890762"

objectstring

The type of object which was deleted. - collection

Value:"collection"

Example:"collection"

deletedboolean

Whether the collection was deleted successfully or not.

Example:true

Response

{
  "id": "182",
  "object": "collection",
  "deleted": true
}