Skip to main content

​
POST /api/modules

Creates a new module with the specified name, path, and optional icon.

​
Authentication

Requires authentication with valid JWT token.

​
Request Body

​
name
string
required
Module name (maximum 100 characters)
​
path
string
required
Module path, must start with ’/’ (maximum 200 characters)
​
icon
string
Optional icon identifier (maximum 100 characters)

​
Response

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

​
Status Codes

  • 201 Created - Module created successfully
  • 400 Bad Request - Invalid request data (validation errors)
  • 409 Conflict - Module already exists

​
Example Request

curl -X POST https://api.example.com/api/modules \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "User Management",
    "path": "/users",
    "icon": "users-icon"
  }'

​
Example Response

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

​
Error Response

{
  "timestamp": "2026-03-04T10:30:00Z",
  "status": 400,
  "error": "Bad Request",
  "message": "El path debe comenzar con '/'",
  "path": "/api/modules"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us