Deleting a category

Delete category

Deleting a category is done by sending a DELETE request to the /categories/:id endpoint.

A scoped API key cannot delete a category that is one of its scope anchors. See Authentication.

CURL


curl -X DELETE https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID] \ 
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \

JavaScript / Node.js


const response = await fetch(`https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID]`, {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer YOUR_TOKEN`,
  }
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID]', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_TOKEN',
  ]
]);

Response

The response is the deleted category object with a status message. If the id does not exist, the response is 403 with the Payload error. A missing id and a forbidden id return the same body. See Authentication.


{
  doc: {
    "id": "[CATEGORY_ID]",
    "title": "Category title",
    "slug": "category-slug"
  },
  message: "Deleted successfully."
}