Eliminar uma categoria

Eliminar categoria

Eliminar uma categoria faz-se enviando um pedido DELETE para o endpoint /categories/:id.

Uma Chave API com âmbito não pode eliminar uma categoria que seja uma das suas âncoras de âmbito. Consulta Autenticação.

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',
  ]
]);

Resposta

A resposta é o objeto de categoria eliminado, com uma mensagem de estado. Se o id não existir, a resposta é 403 com o erro do Payload. Um id em falta e um id proibido devolvem o mesmo corpo. Consulta Autenticação.


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