Update a category

Update category

Updating a single category is done by sending a PATCH request to the /categories/:id endpoint.

Writable fields are title (max 100), slug, description (max 2000), and parent (a category id). A category API key can only update categories inside its category scope.

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

Response

The response is an object containing the category object and an update 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": "New category title",
    ...
  },
  message: "Updated successfully."
}