Skip to main content
PATCH
http://localhost:3000
/
tag-groups
/
{id}
curl -X PATCH 'https://api.example.com/tag-groups/tag_group_priority' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Priority Level",
    "description": "Updated priority levels"
  }'
{
  "id": "tag_group_priority",
  "scopeId": "scope_acme",
  "name": "Priority Level",
  "key": "priority",
  "description": "Updated priority levels",
  "origin": "user",
  "maxAppliedPerTarget": 1,
  "isLocked": false,
  "createdBy": "user-1",
  "createdAt": "2024-01-15T10:30:00Z"
}

Path Parameters

id
string
required
ID of the tag group to update

Request Body

name
string
Display name for the tag group
description
string
Description of the tag group
maxAppliedPerTarget
number
Maximum number of tags from this group that can be applied to a single target
isLocked
boolean
Whether the tag group is locked from modifications

Response

Returns the updated tag group object.
curl -X PATCH 'https://api.example.com/tag-groups/tag_group_priority' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Priority Level",
    "description": "Updated priority levels"
  }'
{
  "id": "tag_group_priority",
  "scopeId": "scope_acme",
  "name": "Priority Level",
  "key": "priority",
  "description": "Updated priority levels",
  "origin": "user",
  "maxAppliedPerTarget": 1,
  "isLocked": false,
  "createdBy": "user-1",
  "createdAt": "2024-01-15T10:30:00Z"
}