> ## Documentation Index > Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt > Use this file to discover all available pages before exploring further. # Create custom module > Creates a custom module. A matching view permission (`view/`) is created at the same time and added to your own role, so you see the new menu right away; give it to other roles to share the module. `url` must be a valid URL. It may contain `{SHORT_TOKEN}`, which is replaced with a short-lived token for the signed-in user when the module opens. Rules: - `name`: required, at most 50 characters, letters, numbers, spaces and `-` only, unique in your organization. It cannot be changed later. - `type`: `WEB`, `MOBILE` or `ADDONS`. - `pluginId`: required when `type` is `ADDONS`; the add-on must be global or your own, used once per organization, with a URL no other module uses. - `target`: `_blank` (new tab, default) or `_self`. Requires permission `add/customModule`. ## OpenAPI ````yaml /openapi/public/openapi-setting.json post /custom-module openapi: 3.0.0 info: title: API - Setting version: 3.0.0 description: API Documentation - RESTful API for field operations management. servers: - url: https://apiweb.mile.app/api/v3 security: - bearerAuth: [] tags: - name: User description: >- User data includes information contained within a user account, such as details that define a user's hub access and role within the system. Hub access determines the locations or areas of the application a user can access or the specific actions they can perform. User attributes consist of the user ID, name, email, and status. The app provides five predefined user roles, and you can create custom roles based on your organization's needs. The predefined roles are **Owner, Admin, Planner, and Field user**. A user can only hold one role at a time but can be granted access to multiple hubs. - name: Team description: >- This API allows you to manage teams. It serves as a tool to effectively manage and restrict user task assignments within your organization. **To see the details of team object, please follow [this link](#tag/team_model)** - name: Role description: >- This API enables you to retrieve a list of predefined roles and any custom roles associated with your account. By making a GET request to this API, you can obtain information about the available roles within the system. The predefined roles refer to a set of role types that are already defined by the system. In this particular case, the predefined roles include Finance, Owner, Planner, Admin, and Field User. Additionally, the API may also return any custom roles that have been created within your account. **To see the details of role object, please follow [this link](#tag/role_model)** - name: Hub description: >- In our system, a Hub is a fundamental entity within an organization, serving as the central point for managing various operational components. It acts as the parent structure for a wide range of resources and functionalities, including tasks, visits, users, vehicles, routing results, routing configurations, and data sources. **To see the details of hub object, please follow [this link](#tag/hub_model)** ## Conceptual Understanding of Hubs - **User Perspective:** For users, a Hub represents their headquarters or primary working area. It is where they carry out their daily activities and manage their tasks effectively. Each user interacts with the Hub to access resources and perform operations specific to their roles. - **Task Perspective:** From the perspective of task management, the Hub signifies the working area for tasks. It is the location where tasks are initiated, monitored, and completed. The Hub facilitates organization and efficiency in task execution. - **Routing Perspective:** In the context of routing and logistics, a Hub serves as a critical location for vehicles. It is where vehicles begin their routes, return after completing their journeys, and may make strategic stops along the way. The routing module relies on the Hub to optimize vehicle assignments and manage routes effectively. - name: App Integration description: >- This API allows you to manage Integration of enterprise app. Currently available for Azure. **To see the details of integration object, please follow [this link](#tag/app_integration_model)** - name: Plugin description: >- The Plugin API allows developers to create and manage custom add-ons within the app. Plugins enable dynamic functionality through JavaScript resources and custom icons, allowing organizations to extend platform capabilities with custom features and integrations. **To see the details of plugin object, please follow [this link](#tag/plugin_model)** - name: Organization description: >- Organization management endpoints for configuring organization-level settings and preferences. - name: Addon description: Addon endpoints - name: Custom Module description: >- A "custom module" is like a personalized menu option in MileApp. It's something you can create and customize to make it easy to access specific features or content. - name: Password Policy description: >- Password Policy endpoints for configuring password requirements and security policies for your organization. - name: Trash description: >- Trash lists items that were deleted from your organization, so you can see what was removed and when. paths: /custom-module: post: tags: - Custom Module summary: Create custom module description: >- Creates a custom module. A matching view permission (`view/`) is created at the same time and added to your own role, so you see the new menu right away; give it to other roles to share the module. `url` must be a valid URL. It may contain `{SHORT_TOKEN}`, which is replaced with a short-lived token for the signed-in user when the module opens. Rules: - `name`: required, at most 50 characters, letters, numbers, spaces and `-` only, unique in your organization. It cannot be changed later. - `type`: `WEB`, `MOBILE` or `ADDONS`. - `pluginId`: required when `type` is `ADDONS`; the add-on must be global or your own, used once per organization, with a URL no other module uses. - `target`: `_blank` (new tab, default) or `_self`. Requires permission `add/customModule`. operationId: addCustomModule requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomModuleCreateRequest' required: true responses: '201': description: Created content: application/json: schema: type: object properties: status: type: boolean message: type: string data: type: object description: The new custom module. additionalProperties: true permission: type: object description: The view permission created for it. additionalProperties: true example: status: true message: >- Custom Module `Driver Dashboard` has been added successfully. data: _id: 6710c3e5e4b0a91d2c3f7d44 name: Driver Dashboard label: driver-Dashboard-64d99303be0ad015c461c932 type: string url: https://dashboard.example.com/?token={SHORT_TOKEN} target: _blank organizationId: 64d99303be0ad015c461c932 createdFrom: WEB updatedTime: '2026-10-16T03:30:00.000000Z' createdTime: '2026-10-16T03:30:00.000000Z' permission: _id: 6710c3e5e4b0a91d2c3f7d45 name: view/driver-Dashboard-64d99303be0ad015c461c932 displayName: View Driver Dashboard menu: Driver Dashboard type: string orderIndex: 1760585400 updatedTime: '2026-10-16T03:30:00.000000Z' createdTime: '2026-10-16T03:30:00.000000Z' '400': description: Bad Request content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Bad request - invalid parameters provided. '404': description: Data not found content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Data not found '500': description: Server error content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Internal server error, please contact support@mile.app. deprecated: false security: - bearerAuth: [] components: schemas: CustomModuleCreateRequest: type: object required: - name - type - url properties: name: type: string maxLength: 50 description: |- Module name. Letters, numbers, spaces and `-` only. **Example:** `Driver Dashboard` inputType: type: string description: The input type of the component (e.g., string, number, date, etc.) url: type: string description: |- Page URL. May contain `{SHORT_TOKEN}`. **Example:** `https://dashboard.example.com/?token={SHORT_TOKEN}` pluginId: type: string description: |- Add-on ID. Required when `type` is `ADDONS`. **Example:** `68b440c9dad4c5d45707f6d2` target: type: string enum: - _blank - _self description: |- Open in a new tab (`_blank`) or the same tab (`_self`). **Default:** `_blank` example: name: Driver Dashboard type: string url: https://dashboard.example.com/?token={SHORT_TOKEN} target: _blank securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Use a valid Bearer token to authenticate. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.