Update a group

Updates information about an existing group. The operation returns the updated group information and all of its users.

Request
query Parameters
group_name
required
string

The name of the group.

Example: group_name=NYC Office
header Parameters
API-Token
required
string

The API token that is shown in the settings of Notes. It is a 64-digit hex number.

Example: a48865e51c3f4610de8f319bdd7bf691b2aaad827ed31ad1dd6847e617200666
Request Body schema: application/json; charset=utf-8
name
string

The new name of the group.

description
string

The new description about the group.

Responses
200
put/api/v1/groups/{group_name}
Request samples
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "success": true,
  • "id": 113,
  • "name": "NYC Office",
  • "description": "Engineers in NYC",
  • "created_at": "2020-02-12T21:50:59.774Z",
  • "updated_at": "2020-02-12T21:50:59.774Z",
  • "users": [
    ]
}