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

# Suspend Employee

> Suspend Employee.



## OpenAPI

````yaml /api-reference/ops/openapi.json post /api/v1/ops/employees/{employeeId}/suspend
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/employees/{employeeId}/suspend:
    post:
      tags:
        - Employee
      summary: Suspend Employee
      description: Suspend Employee.
      operationId: suspendOpsEmployee
      parameters:
        - name: employeeId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            description: Employee 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '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
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 404
                required:
                  - message
                  - statusCode
              example:
                message: Resource not found
                statusCode: 404
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 409
                required:
                  - message
                  - statusCode
              example:
                message: Conflict
                statusCode: 409
        '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: []
        - bearer: []
components:
  schemas:
    Employee:
      type: object
      properties:
        employeeId:
          type: string
          format: uuid
          description: Identificador único
        companyId:
          type: string
          format: uuid
          description: Empresa dona do vínculo de funcionário
        organizationId:
          type: string
          format: uuid
          description: Organização da Company associada à Membership
        membershipId:
          type: string
          format: uuid
          description: Membership que originou o vínculo
        membership:
          $ref: '#/components/schemas/EmployeeMembership'
        userId:
          type: string
          format: uuid
          description: Usuário vinculado à Membership
        user:
          $ref: '#/components/schemas/EmployeeUser'
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Perfil de cliente/passageiro associado ao funcionário, quando
            existir
        employeeCode:
          type: string
          nullable: true
          description: Código interno do funcionário na Company
        jobTitle:
          type: string
          nullable: true
          description: Cargo informado pela Company
        department:
          type: string
          nullable: true
          description: Departamento informado pela Company
        status:
          type: string
          enum:
            - ACTIVE
            - SUSPENDED
            - REVOKED
          description: Status do vínculo
        activatedAt:
          type: string
          format: date-time
          description: Data em que o vínculo ficou ativo
        suspendedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de suspensão do vínculo
        revokedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de revogação do vínculo
        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 lógica
      required:
        - employeeId
        - companyId
        - organizationId
        - membershipId
        - membership
        - userId
        - user
        - customerId
        - employeeCode
        - jobTitle
        - department
        - status
        - activatedAt
        - suspendedAt
        - revokedAt
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
      description: Funcionário de uma Company vinculado a uma Membership
    EmployeeMembership:
      type: object
      properties:
        membershipId:
          type: string
          format: uuid
          description: Membership identifier
        organizationId:
          type: string
          format: uuid
          nullable: true
          description: Organization identifier
        roleId:
          type: string
          format: uuid
          description: Role identifier
        createdAt:
          type: string
          format: date-time
          description: Creation date
        updatedAt:
          type: string
          format: date-time
          description: Last update date
      required:
        - membershipId
        - organizationId
        - roleId
        - createdAt
        - updatedAt
      description: Basic membership data exposed with employee resources
    EmployeeUser:
      type: object
      properties:
        userId:
          type: string
          format: uuid
          description: User identifier
        name:
          type: string
          description: User name
        email:
          type: string
          format: email
          nullable: true
          description: User email
        phoneIso:
          type: string
          description: Phone country ISO code
        phoneDdi:
          type: string
          description: Phone country calling code
        phoneNumber:
          type: string
          description: Phone number
        phoneVerified:
          type: boolean
          description: Whether the phone is verified
        emailVerified:
          type: boolean
          description: Whether the email is verified
        avatar:
          type: string
          nullable: true
          description: Avatar URL
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - BLOCKED
          description: User status
      required:
        - userId
        - name
        - email
        - phoneIso
        - phoneDdi
        - phoneNumber
        - phoneVerified
        - emailVerified
        - avatar
        - status
      description: Basic user data exposed with employee resources
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````