Skip to main content
PATCH
/
tag-groups
/
{tagGroupId}
Update a tag group
curl --request PATCH \
  --url https://openapi.pleo.io/v1/tag-groups/{tagGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "tagAttributes": [
    {
      "id": "0f0e000-000d-0d00-000b-00db0d000fae",
      "name": "<string>",
      "displayOrder": 123,
      "hidden": true
    }
  ],
  "archived": true
}
'
{
  "id": "0f0e000-000d-0d00-000b-00db0d000fae",
  "name": "<string>",
  "tagAttributes": [
    {
      "id": "0f0e000-000d-0d00-000b-00db0d000fae",
      "name": "<string>",
      "displayOrder": 123,
      "hidden": true
    }
  ],
  "archived": true
}

Authorizations

​
Authorization
string
header
required

Open API Bearer token

Path Parameters

​
tagGroupId
string
required

Unique UUID of the tag group.

Example:

"0f0e000-000d-0d00-000b-00db0d000fae"

Body

application/json
​
name
string

This is the tag group name supplied on create

​
tagAttributes
object[]

These are the attributes that define a tag in this tag group

​
archived
boolean

This flag specifies whether the tag group has been archived in the pleo system or not

Response

Tag group has been updated

​
id
string
required

This is the internal pleo identifier of the tag group

Example:

"0f0e000-000d-0d00-000b-00db0d000fae"

​
name
string
required

This is the tag group name supplied on create

​
tagAttributes
object[]
required

These are the attributes that define a tag in this tag group, i.e. the tag columns. Each tag column is included only once.

​
archived
boolean
required

This flag specifies whether the tag group has been archived in the Pleo system or not