Eine Kategorie aktualisieren

Kategorie aktualisieren

Das Aktualisieren einer Kategorie erfolgt durch Senden einer PATCH-Anfrage an den Endpoint /categories/:id.

Beschreibbare Felder sind title (max. 100), slug, description (max. 2000) und parent (eine Kategorie-Id). Ein API-Key mit Kategorie-Scope kann nur Kategorien innerhalb seines Kategorie-Scopes aktualisieren.

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

Antwort

Die Antwort ist ein Objekt mit dem Kategorie-Objekt und einer Aktualisierungsnachricht. Wenn die Id nicht existiert, ist die Antwort 403 mit dem Payload-Fehler. Eine fehlende Id und eine verbotene Id liefern denselben Body. Siehe Authentifizierung.


{
  doc: {
    "id": "[CATEGORY_ID]",
    "title": "New category title",
    ...
  },
  message: "Updated successfully."
}