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

# Update Role

> Updates a role.



## OpenAPI

````yaml /api-reference/ops/openapi.json patch /api/v1/ops/roles/{roleId}
openapi: 3.0.0
info:
  title: DEVMOB OPS API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Bank Account
    description: Bank accounts
  - name: Benefit
    description: Benefit categories and usage history
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Credit Grant
    description: Company granted credits
  - name: Driver
    description: Company drivers
  - name: Employee
    description: Company employees
  - name: Employee Session
    description: Employee sessions
  - name: Export
    description: Export resources
  - name: Export Job
    description: Immediate export jobs
  - name: Export Schedule
    description: Scheduled exports
  - name: Invite
    description: Member invitations
  - name: Notification
    description: OPS inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Orders
  - name: Organization
    description: Organization profile
  - name: Organization Address
    description: Organization address
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Permission
    description: Permissions
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated OPS profile
  - name: Promotion
    description: Promotions
  - name: Promotion Rule
    description: Promotion rules
  - name: Receivable
    description: Receivables
  - name: Report
    description: Operational reports
  - name: Role
    description: Roles
  - name: Route
    description: Routes
  - name: Route Approval
    description: Route approvals
  - name: Routing
    description: Routing helpers
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Transfer
    description: Transfers
  - name: Trip
    description: Trips
  - name: Trip Event
    description: Trip operational events
  - name: Trip Schedule
    description: Recurring trip schedules
  - name: Trip Tracking
    description: Trip GPS tracking
  - name: Vehicle
    description: Vehicles and seats
paths:
  /api/v1/ops/roles/{roleId}:
    patch:
      tags:
        - Role
      summary: Update Role
      description: Updates a role.
      operationId: updateRole
      parameters:
        - name: roleId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            description: Role identifier
            example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: OK
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
components:
  schemas:
    UpdateRoleRequest:
      type: object
      properties:
        description:
          type: string
          description: Role description
          example: Acesso total à organização
          nullable: true
        name:
          type: string
          description: Role name
          example: Administrador
        permissions:
          type: array
          items:
            type: string
            enum:
              - access:ops
              - access:bko
              - access:driver
              - read:organization
              - update:organization
              - read:role
              - create:role
              - update:role
              - delete:role
              - read:member
              - create:member
              - update:member
              - delete:member
              - read:invite
              - create:invite
              - delete:invite
              - read:vehicle
              - create:vehicle
              - update:vehicle
              - delete:vehicle
              - read:seat-type
              - read:driver
              - create:driver
              - update:driver
              - delete:driver
              - read:point
              - create:point
              - update:point
              - delete:point
              - read:route
              - create:route
              - update:route
              - delete:route
              - read:bank_account
              - update:bank_account
              - read:payment
              - read:trip
              - create:trip
              - update:trip
              - delete:trip
              - read:trip_schedule
              - create:trip_schedule
              - update:trip_schedule
              - delete:trip_schedule
              - create:trip_event
              - read:order
              - create:order
              - update:order
              - read:ticket
              - create:ticket
              - update:ticket
              - delete:ticket
              - read:balance
              - read:receivable
              - read:transfer
              - create:transfer
              - read:audit
              - read:user
              - update:user
              - read:benefit_category
              - create:benefit_category
              - update:benefit_category
              - delete:benefit_category
              - read:benefit_program
              - create:benefit_program
              - update:benefit_program
              - delete:benefit_program
            description: Permission identifier
            example: create:trip
          description: Granted permissions
          example:
            - read:trip
            - create:trip
      description: Update role payload
    Role:
      type: object
      properties:
        roleId:
          type: string
          format: uuid
          description: Identificador único
        organizationId:
          type: string
          format: uuid
          nullable: true
          description: Referência à organização; preenchido apenas para ORGANIZATION
        type:
          type: string
          enum:
            - INTERNAL
            - ENVIRONMENT
            - ORGANIZATION
          description: Tipo da role (INTERNAL, ENVIRONMENT ou ORGANIZATION)
        name:
          type: string
          description: 'Nome do papel (ex.: "Admin", "Agente")'
        description:
          type: string
          nullable: true
          description: Descrição do papel
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
        deletedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que removeu o registro, quando aplicável
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de remoção
      required:
        - roleId
        - organizationId
        - type
        - name
        - description
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
      description: Papéis de acesso internos, de ambiente ou customizados por organização
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````