Mettre à jour une catégorie

Mettre à jour catégorie

La mise à jour d’une catégorie se fait en envoyant une requête PATCH à l’endpoint /categories/:id.

Les champs modifiables sont title (100 max), slug, description (2000 max) et parent (un id de catégorie). Une Clé API avec périmètre ne peut mettre à jour que les catégories de son périmètre de catégories.

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

Réponse

La réponse est un objet contenant l’objet catégorie et un message de mise à jour. Si l’id n’existe pas, la réponse est 403 avec l’erreur Payload. Un id manquant et un id interdit renvoient le même corps. Voir Authentification.


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