Update Group

​

Change a group's name, description, members or workshop items. Send only the fields to change.

members replaces the whole list: the group ends up with exactly the users you send, and [] removes everyone. To add or remove one user, read the group, edit the list and send all of it. Updates are not locked or merged, so don't update the same group from two places at once. workshop_items works the same way, and a workflow returned as app can be sent back as app.

If the tenant syncs groups through SCIM, the next sync can overwrite changes made here.

Requires an API key for an MSP user whose role includes the Manage Groups permission. Tenant (company) users, including tenant admins, receive 403. Groups in tenants your MSP does not manage are never returned or changed.

Path Parameters

  • group_id
    Type: string
    required

    Group HashID

    Group HashID (e.g., group_abc123)

Body·

required
application/json

Send only the fields to change. Omitted fields keep their current values.

  • description
    Type: stringnullable

    New group description

  • members
    Type: array of stringnullable

    Replaces the whole member list: the group ends up with exactly these users. [] removes everyone. Omit to leave members unchanged.

  • name
    Type: string
    min length:  
    3
    max length:  
    72    nullable

    New group name: 3-72 characters, letters, numbers and spaces only

  • workshop_items
    Type: array of AdminWorkshopItemInputnullable

    Replaces all apps, workflows and agents shared with the group. [] removes them all. Omit to leave them unchanged.

    Properties: 2

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/admin/groups/{group_id}
curl 'https://ai.hatz.ai/v1/admin/groups/{group_id}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Sales EMEA"
}'

{
  "id": "group_X7VAK72dp5nX3Cd6JXwdPg6OxD",
  "name": "Sales",
  "description": "Sales team",
  "tenant_id": "tenant_abc123",
  "owner": {
    "id": "user_gE4JlrAxlgKXEfvA3jZexy6Pxq",
    "email": "admin@yourmsp.com",
    "first_name": "Alex",
    "last_name": "Admin"
  },
  "members": [
    {
      "id": "user_n55abP89ZowO6iKAx7vqWjrqnZ",
      "email": "sam@example.com",
      "first_name": "Sam",
      "last_name": "Rivera"
    }
  ],
  "workshop_items": [
    {
      "id": "5143da6d-c5de-4c2f-a0b6-3df4d0e542f0",
      "item_type": "agent"
    }
  ],
  "created_at": "2026-11-05T20:02:42.715415+00:00",
  "updated_at": "2026-11-05T20:02:42.715415+00:00"
}

The updated group

Previous
Get Group
Next
Delete Group