> ## 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.

# Update member

> Updates another member of your organization: name, hubs, teams, role, phone number, language or status.
Requires permission `edit/member`.
Rules:
- `name`: 4-30 characters, letters, numbers, spaces and `- ' + _ .` only.
- `phoneNumber`: country code with `+`, a space, then the number, 10-16 characters, e.g. `+62 81234567890`.
- `status`: `active` or `disable`. You cannot disable yourself or an owner.
- An organization always keeps at least one active owner, so the last owner's role cannot be changed.
- Changing `hubId` removes the member from teams of hubs they no longer belong to.
- Setting `password` signs the member out of all sessions.
You can only edit members who share a hub with you.



## OpenAPI

````yaml /openapi/public/openapi-setting.json put /member/{userId}
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:
  /member/{userId}:
    put:
      tags:
        - User
      summary: Update member
      description: >-
        Updates another member of your organization: name, hubs, teams, role,
        phone number, language or status.

        Requires permission `edit/member`.

        Rules:

        - `name`: 4-30 characters, letters, numbers, spaces and `- ' + _ .`
        only.

        - `phoneNumber`: country code with `+`, a space, then the number, 10-16
        characters, e.g. `+62 81234567890`.

        - `status`: `active` or `disable`. You cannot disable yourself or an
        owner.

        - An organization always keeps at least one active owner, so the last
        owner's role cannot be changed.

        - Changing `hubId` removes the member from teams of hubs they no longer
        belong to.

        - Setting `password` signs the member out of all sessions.

        You can only edit members who share a hub with you.
      operationId: updateMember
      parameters:
        - name: userId
          in: path
          required: true
          description: |-
            The identifier of the member.
            **Example:** `621dd813eb3ebf16b94d6969`
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsMemberUpdateRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  data:
                    description: Updated member.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  data:
                    _id: 621dd813eb3ebf16b94d6969
                    name: Rina Putri
                    email: rina@example.com
                    phoneNumber: +62 81234567890
                    hubId:
                      - 64d9932e2beb9037735ff022
                    teamId: []
                    roleId: 6449f8ef2c481b07d40ecfc5
                    organizationId: 64d99303be0ad015c461c932
                    language: en
                    status: active
                    updatedTime: '2026-10-16T03:20:00.000000Z'
                    createdTime: '2025-01-10T02:00:00.000000Z'
                  message: Data has been updated successfully.
                  statusCode: 200
                  billingUpdated: false
                  licenseDowngraded: false
        '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.
        '401':
          description: Unauthorized
          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:
    SettingsMemberUpdateRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 4
          maxLength: 30
          description: |-
            Member name.
            **Example:** `Rina Putri`
        hubId:
          type: array
          minItems: 1
          items:
            type: string
          description: |-
            Hub IDs the member belongs to. At least one, no duplicates.
            **Example:** `["64d9932e2beb9037735ff022"]`
        teamId:
          type: array
          items:
            type: string
          description: |-
            Team IDs, no duplicates.
            **Example:** `["650138dee2683e0e7c6b0ed2"]`
        roleId:
          type: string
          description: |-
            Role ID from your organization.
            **Example:** `6449f8ef2c481b07d40ecfc5`
        phoneNumber:
          type: string
          minLength: 10
          maxLength: 16
          description: |-
            Phone number as `+ `. Send `null` to clear it.
            **Example:** `+62 81234567890`
        language:
          type: string
          enum:
            - en
            - id
            - jp
            - zh
            - vi
            - th
            - tl
            - ko
          description: |-
            Member's app language.
            **Example:** `en`
        status:
          type: string
          enum:
            - active
            - disable
          description: |-
            Account status.
            **Example:** `active`
        password:
          type: string
          description: >-
            New password for the member. Setting it signs the member out of
            every session.
      example:
        name: Rina Putri
        hubId:
          - 64d9932e2beb9037735ff022
        roleId: 6449f8ef2c481b07d40ecfc5
        phoneNumber: +62 81234567890
        status: active
  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.