> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mileapp.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Update hub



## OpenAPI

````yaml /openapi/public/openapi-setting.json put /hub/{hubId}
openapi: 3.0.0
info:
  title: MileApp API - Setting
  version: 3.0.0
  description: MileApp 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.


      MileApp 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 Mile V3 platform. 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)**
paths:
  /hub/{hubId}:
    put:
      tags:
        - Hub
      summary: Update hub
      operationId: updateHub
      parameters:
        - name: hubId
          in: path
          required: true
          description: |-
            Unique identifier for the hub that generated by system.
            **Example**: `642634bde1428d414838c882`
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubUpdateRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                properties:
                  status:
                    description: Status of response.
                    type: string
                  property:
                    description: Detail of updated hub.
                    type: object
                    additionalProperties: true
                  message:
                    description: Message of API response.
                    type: string
                example:
                  status: true
                  property:
                    _id: 642634bde1428d414838c882
                    name: Dukuh Atas
                    address: >-
                      12, Jalan Setia Budi VI, Dukuh Atas, Jakarta Selatan
                      12910, Indonesia
                    lat: -6.205870636762187
                    lng: 106.82562818235002
                    organizationId: 63c76fdb88697c70e35866e2
                    updatedTime: '2023-03-31T01:31:48.809000Z'
                    createdTime: '2023-03-31T01:17:49.158000Z'
                    deleteAccess: true
                  message: Success
        '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:
    HubUpdateRequest:
      title: HubUpdateRequest
      example:
        name: Dukuh Atas
        address: 12, Jalan Setia Budi VI, Dukuh Atas, Jakarta Selatan 12910, Indonesia
        lat: '-6.205870636762187'
        lng: '106.82562818235002'
      type: object
      properties:
        name:
          type: string
          description: >-
            The name of hub. User can define hub name with hub's location, or
            something else.

            **Example**: `Hub transit Jakarta`
        address:
          type: string
          description: Location of the hub. **Example:** `'Neo Soho, Jakarta Barat'`
        lat:
          type: number
          format: double
          description: Coordinate latitude of visit. **Example:** `'-6.230815251666679'`
        lng:
          type: number
          format: double
          description: Coordinate longitude of visit. **Example:** `'106.75684387903198'`
      required:
        - name
        - address
        - lat
        - lng
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````