Pawsitive Future Pawsitive FutureDeveloper docs

patch_org_admin_groups_by_groupid

Changes data · you confirm first

Calls PATCH /api/org-admin/groups/{groupId} as the signed-in person · REST reference

Rename a group of the organization, or change its description

With the caller's own token. Requires admin.groups.manage in the GROUP's organization, which the DAL reads from the group. What a group grants is its roles — see PUT /api/org-admin/groups/{groupId}/roles.

Arguments

ArgumentTypeDescription
groupIdpathstring (uuid)required
bodyJSONobjectrequiredThe request body, as a JSON object. Its fields are listed below.

Fields of body

FieldTypeDescription
descriptionstring
namestring

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "patch_org_admin_groups_by_groupid",
    "arguments": {
      "groupId": "11111111-1111-4111-8111-111111111111",
      "body": {
        "description": "string",
        "name": "string"
      }
    }
  }
}
Confirmation
The client shows the person the exact request and waits. Nothing runs until they tick Make this change. See Reading and changing.

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The group was updated.

json
{
  "success": true,
  "data": {},
  "message": "string"
}

Fields

FieldTypeDescription
dataanyThe payload; absent when the operation returns nothing.
messagestring
successtrue

When it fails

A failed call returns isError: true with the API's message as text. A change the person declines, or lets time out, also comes back this way and nothing changes.

400

The request was malformed or failed a guard.

403

Authenticated, but the caller holds none of the required permissions.

404

No such resource — or none this caller may see.

409

The resource is not in a state that allows this operation.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json
{
  "name": "patch_org_admin_groups_by_groupid",
  "description": "PATCH /api/org-admin/groups/{groupId} — With the caller's own token. Requires `admin.groups.manage` in the GROUP's organization, which the DAL reads from the group. What a group grants is its roles — see `PUT /api/org-admin/groups/{groupId}/roles`.\n\nThis changes data. The person is asked to confirm it before it runs, and nothing happens if they decline.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "groupId": {
        "type": "string"
      },
      "body": {
        "type": "string",
        "description": "The JSON request body: { description: string; name: string }"
      }
    },
    "required": [
      "groupId",
      "body"
    ]
  },
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": false,
    "openWorldHint": false
  }
}