Skip to main content
PATCH
/
groups
/
{id}
Update a group
curl --request PATCH \
  --url https://app.heyoo.ai/api/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "count": 123,
  "createdAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
id
string
required

The ID of the group to update.

Body

application/json
​
name
string
required

The name of the tag to create.

Required string length: 1 - 50
​
description
string

The description of the tag to create.

Response

The updated group.

​
id
string
required

The unique ID of the group.

​
name
string
required

The name of the group.

​
count
number
required

The number of users in the group.

​
createdAt
string
required

The creation date of the group.