Update a role - Mihu API Documentation

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/workspace/roles/{role} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Senior Loop Agent",
  "product_key": "loop",
  "scopes": [
    "loop.conversations.view",
    "loop.conversations.reply",
    "loop.calls.place"
  ]
}
'

{
  "success": true,
  "message": "Workspace role updated",
  "data": {
    "role": {
      "uuid": "22222222-2222-4222-8222-222222222222",
      "key": "loop_agent",
      "name": "Senior Loop Agent",
      "product_key": "loop",
      "product_label": "Loop",
      "scopes": [
        "loop.conversations.view",
        "loop.conversations.reply",
        "loop.calls.place"
      ],
      "members_count": 4,
      "is_system": false,
      "created_at": "2026-08-08T20:12:00+00:00",
      "updated_at": "2026-08-08T20:15:00+00:00"
    }
  }
}

{
  "success": false,
  "message": "System roles cannot be updated",
  "data": []
}

{
  "success": false,
  "message": "Workspace role not found",
  "data": []
}

{
  "success": false,
  "message": "Validation failed",
  "data": {
    "scopes": [
      "The selected scopes must belong to the selected product."
    ]
  }
}

PUT

api

workspace

roles

{role}

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/workspace/roles/{role} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Senior Loop Agent",
  "product_key": "loop",
  "scopes": [
    "loop.conversations.view",
    "loop.conversations.reply",
    "loop.calls.place"
  ]
}
'

{
  "success": true,
  "message": "Workspace role updated",
  "data": {
    "role": {
      "uuid": "22222222-2222-4222-8222-222222222222",
      "key": "loop_agent",
      "name": "Senior Loop Agent",
      "product_key": "loop",
      "product_label": "Loop",
      "scopes": [
        "loop.conversations.view",
        "loop.conversations.reply",
        "loop.calls.place"
      ],
      "members_count": 4,
      "is_system": false,
      "created_at": "2026-08-08T20:12:00+00:00",
      "updated_at": "2026-08-08T20:15:00+00:00"
    }
  }
}

{
  "success": false,
  "message": "System roles cannot be updated",
  "data": []
}

{
  "success": false,
  "message": "Workspace role not found",
  "data": []
}

{
  "success": false,
  "message": "Validation failed",
  "data": {
    "scopes": [
      "The selected scopes must belong to the selected product."
    ]
  }
}

Authorizations

Authorization

string

header

required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

role

string

required

Role UUID or key

Body

application/json

name

string

Maximum string length: 255

Example:

"Senior Loop Agent"

key

string

Maximum string length: 255

Example:

"senior_loop_agent"

product_key

string

Optional; when given, scopes must be supplied and must belong to this product

Example:

"loop"

scopes

string[]

The role's complete new scope set, all from one product

Response

Role updated

success

boolean

Example:

true

message

string

Example:

"Workspace role updated"

data

object

Show child attributes