Skip to main content

PUT /api/modules/

Updates an existing module’s name, path, and icon.

Authentication

Requires authentication with valid JWT token.

Path Parameters

id
UUID
required
The unique identifier of the module to update

Request Body

name
string
New module name (maximum 100 characters)
path
string
New module path (maximum 200 characters, must start with ’/’)
icon
string
New icon identifier (maximum 100 characters)

Response

id
UUID
Unique identifier for the module
name
string
Updated module name
path
string
Updated module path
icon
string
Updated module icon identifier
status
string
Module status (e.g., ACTIVE, INACTIVE)

Status Codes

  • 200 OK - Module updated successfully
  • 400 Bad Request - Invalid request data
  • 404 Not Found - Module not found

Example Request

curl -X PUT https://api.example.com/api/modules/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "User Administration",
    "path": "/admin/users",
    "icon": "admin-users-icon"
  }'

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "User Administration",
  "path": "/admin/users",
  "icon": "admin-users-icon",
  "status": "ACTIVE"
}

Error Response

{
  "timestamp": "2026-03-04T10:30:00Z",
  "status": 404,
  "error": "Not Found",
  "message": "Module not found with id: 550e8400-e29b-41d4-a716-446655440000",
  "path": "/api/modules/550e8400-e29b-41d4-a716-446655440000"
}

Build docs developers (and LLMs) love