Atualizar uma categoria

Atualizar categoria

Atualizar uma única categoria faz-se enviando um pedido PATCH para o endpoint /categories/:id.

Os campos graváveis são title (máx. 100), slug, description (máx. 2000) e parent (um id de categoria). Uma Chave API com âmbito de categoria só pode atualizar categorias dentro do seu âmbito de categoria.

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID] \ 
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "New category title"}'

JavaScript / Node.js


const dataToUpdate = {
  "title": "New category title"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID]`, {
  method: 'PATCH',
  body: JSON.stringify(dataToUpdate),
  headers: {
    'Authorization': `Bearer YOUR_TOKEN`,
    'Content-Type': 'application/json'
  }
});

PHP


$client = new GuzzleHttp\Client();
$dataToUpdate = [
  "title" => "New category title"
];
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/categories/[CATEGORY_ID]', [
  'body' => json_encode($dataToUpdate),
  'headers' => [
    'Authorization' => 'Bearer YOUR_TOKEN',
    'Content-Type' => 'application/json'
  ]
]);

Resposta

A resposta é um objeto que contém o objeto de categoria e uma mensagem de atualização. 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": "New category title",
    ...
  },
  message: "Updated successfully."
}