Patch a Specific Category

This endpoint patches a specific category.

info

This operation requires authentication and admin role.

note

You can use this endpoint to edit a single field passing only the id and the needed field (without mandatory fields).

For example to change active or deleted flags in an admin list/table interface.

HTTP Request

PATCH /api/v2/category/{id}/

Parameters

Name	In	Type	Required	Description
id	path	string	true	A unique integer value identifying this category
body	body	Category	false	The request body(category params)

Example Body Parameters

JSON

{
  "order": "integer",
  "name": "string",
  "name_synonyms": "string",
  "slug": "string",
  "slogan": "string",
  "html_info": "string",
  "seo_title": "string",
  "seo_description": "string",
  "auto_follow": "string",
  "active": "boolean",
  "deleted": "boolean",
  "image_original": "string",
  "emotional_image_original": "string",
  "emotional_image_position": "integer",
  "lastmod_datetime": "string",
  "stream_order_by": "string"
}

Example Request

JavaScript

const inputBody = '{
  "order": "integer",
  "name": "string",
  "name_synonyms": "string",
  "slug": "string",
  "slogan": "string",
  "html_info": "string",
  "seo_title": "string",
  "seo_description": "string",
  "auto_follow": "string",
  "active": "boolean",
  "deleted": "boolean",
  "image_original": "string",
  "emotional_image_original": "string",
  "emotional_image_position": "integer",
  "lastmod_datetime": "string",
  "stream_order_by": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/category/{id}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X PATCH /api/v2/category/{id}/ \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json'
  -H 'Authorization: Bearer {access_token}'
  --DATA '{body}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Category

Example responses

200

{
      "id": "integer",
      "tags": [{Tag}],
      "followed": "boolean",
      "order": "integer",
      "name": "string",
      "name_synonyms": "string",
      "slug": "string",
      "slogan": "string",
      "html_info": "string",
      "seo_title": "string",
      "seo_description": "string",
      "auto_follow": "string",
      "active": "boolean",
      "image_original": "string",
      "image_bigger": "string",
      "image_big": "string",
      "image_medium": "string",
      "image_small": "string",
      "emotional_image_original": "string",
      "emotional_image_position": "integer",
      "lastmod_datetime": "string",
      "stream_order_by": "string",
      "followers_counter": "integer"
}