DELETE/help_center/collections/{collection_id}

Delete a help center collection

Deletes a collection from the help center. Provide the collection identifier to specify which collection to remove. Use this operation when you no longer need the collection.

2 parameters
collection_idintegerrequired
The unique integer identifier assigned to the collection you want to delete.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; listed supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the deleted collection's identifier, object type, and a boolean indicating whether deletion succeeded.
idstringoptional
The unique identifier for the collection which you provided in the URL.
objectstringoptional
The type of object which was deleted. - `collection`
Allowed:collection
deletedbooleanoptional
Whether the collection was deleted successfully or not.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the collection is not found.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the collection is not found. The collection_id path parameter must identify the collection to delete.