Skip to main content

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 authentication and admin role.

HTTP Request

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

Parameters

NameInTypeRequiredDescription
idpathstringtrueA unique integer value identifying this tag
bodybodyTagfalseThe request body(tag params)

Example Body Parameters

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

Example Request


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);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeTag

Example responses

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