Patch a Specific Tag

This endpoint patches a specific tag

info

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 visible flags in an admin list/table interface.

info

This operation requires admin role.

HTTP Request

PATCH /api/v2/tag/{id}/

Parameters

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

Example Body Parameters

JSON

{
  "active": "boolean",
  "type": "string",
  "name": "string",
  "description": "string",
  "color": "string",
  "visible": "boolean"
  "visibility_boost": "boolean",
  "deleted": "boolean"
}

Example Request

JavaScript

const inputBody = '{
  "active": "boolean",
  "type": "string",
  "name": "string",
  "description": "string",
  "color": "string",
  "visible": "boolean"
  "visibility_boost": "boolean",
  "deleted": "boolean"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/tag/{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/tag/{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	Tag

Example responses

200

{
  "id": "integer",
  "type": "string",      
  "name": "string",      
  "description": "string",
  "color": "string",
  "visible": "boolean",
  "visibility_boost": "boolean",
  "created_at": "string",
  "active": "boolean",
  "deleted": "boolean"
}