Update Tag Group
PATCH {{baseUrl}}/api/tag-groups/:id/
Update the tag group with the given tag group ID.
Only a tag group's name
can be changed. A tag group's exclusive
or default
value cannot be changed.
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
tags:read
tags:write
Request Body
{"data"=>{"type"=>"tag-group", "id"=>"<string>", "attributes"=>{"name"=>"<string>", "return_fields"=>["<string>", "<string>"]}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"type":"tag-group","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","exclusive":"\u003cboolean\u003e","default":"\u003cboolean\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}