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

# Desativar um workflow

> Utilize este endpoint para desativar um workflow. Transiciona o status de `active` para `inactive`.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/deactivate
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/workflows/{id}/deactivate:
    post:
      tags:
        - Workflows API
      summary: Desativar um workflow
      description: >-
        Utilize este endpoint para desativar um workflow. Transiciona o status
        de `active` para `inactive`.
      operationId: deactivateWorkflow
      parameters:
        - description: Identificador único do workflow.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutput'
          description: >-
            Indica que a solicitação foi bem-sucedida e a resposta contém os
            dados solicitados.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava malformada ou continha parâmetros
            inválidos.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indica que o recurso solicitado não foi encontrado.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava bem formada, mas contém erros
            semânticos que impedem o processamento.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica um erro interno inesperado. Se persistir, entre em contato
            com o suporte.
components:
  schemas:
    WorkflowOutput:
      example:
        id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        name: Payment Notification Flow
        description: Receives a webhook trigger and logs the payment event.
        status: active
        nodes:
          - id: trigger-1
            type: trigger
            name: Webhook Trigger
            position:
              x: 0
              'y': 0
            data:
              triggerId: webhook
          - id: log-event
            type: action
            name: Log Payment Event
            position:
              x: 200
              'y': 0
            data:
              action: log
        edges:
          - id: e1
            source: trigger-1
            target: log-event
        metadata:
          team: payments
          environment: sandbox
        createdAt: '2026-03-17T14:30:00Z'
        updatedAt: '2026-03-17T14:31:00Z'
      properties:
        createdAt:
          description: Marca temporal de quando o workflow foi criado.
          example: '2026-03-17T14:30:00Z'
          format: date-time
          type: string
        description:
          description: Descrição legível por humanos do workflow.
          example: Receives a webhook trigger and logs the payment event.
          type: string
        edges:
          description: Conexões entre nós que definem o fluxo de execução.
          items:
            $ref: '#/components/schemas/WorkflowEdgeOutput'
          type: array
        id:
          description: Identificador único do workflow.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          format: uuid
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Pares chave-valor personalizados para etiquetar ou categorizar.
          example:
            team: payments
            environment: sandbox
          type: object
        name:
          description: Nome único do workflow.
          example: Payment Notification Flow
          type: string
        nodes:
          description: Os passos que compõem este workflow.
          items:
            $ref: '#/components/schemas/WorkflowNodeOutput'
          type: array
        status:
          description: >-
            Status atual do ciclo de vida: `draft` (editável), `active`
            (executável) ou `inactive` (arquivado).
          enum:
            - draft
            - active
            - inactive
          example: active
          type: string
        updatedAt:
          description: Marca temporal da última atualização.
          example: '2026-03-17T15:00:00Z'
          format: date-time
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro legível por máquina com o prefixo FLK.
          example: FLK-0001
          type: string
        message:
          description: Explicação do erro legível por humanos.
          example: Invalid input provided
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    WorkflowEdgeOutput:
      properties:
        condition:
          description: Expressão de condição para arestas condicionais.
          example: steps.kyc_check.status == 'approved'
          type: string
        id:
          description: Identificador único da aresta.
          example: e1
          type: string
        label:
          description: Rótulo legível por humanos.
          example: On success
          type: string
        source:
          description: ID do nó de origem.
          example: trigger-1
          type: string
        sourceHandle:
          description: Conector no nó de origem.
          example: output-1
          type: string
        target:
          description: ID do nó de destino.
          example: log-event
          type: string
      type: object
    WorkflowNodeOutput:
      properties:
        data:
          additionalProperties:
            type: object
          description: Dados de configuração específicos do tipo de nó.
          example:
            triggerId: webhook
          type: object
        id:
          description: Identificador único do nó dentro do workflow.
          example: trigger-1
          type: string
        name:
          description: Nome de exibição do nó.
          example: Webhook Trigger
          type: string
        position:
          $ref: '#/components/schemas/PositionOutput'
        type:
          description: Tipo do nó.
          example: trigger
          type: string
      type: object
    PositionOutput:
      properties:
        x:
          description: Posição horizontal em pixels.
          example: 100
          type: integer
        'y':
          description: Posição vertical em pixels.
          example: 200
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````