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

# Update, enable, or disable a workflow instance

> Partial update of one instance. Omitted fields keep their stored value; `fields` is merged into the stored fields. Disable by sending enabled=false. recipients replaces selected channels; [] clears them and omission preserves them. The template of an instance cannot change.



## OpenAPI

````yaml /api-reference/platform-api.json patch /v2/workflows/{id}
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.27
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
paths:
  /v2/workflows/{id}:
    patch:
      tags:
        - Workflows
      summary: Update, enable, or disable a workflow instance
      description: >-
        Partial update of one instance. Omitted fields keep their stored value;
        `fields` is merged into the stored fields. Disable by sending
        enabled=false. recipients replaces selected channels; [] clears them and
        omission preserves them. The template of an instance cannot change.
      operationId: updateWorkflow
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowInstanceDto'
components:
  schemas:
    UpdateWorkflowDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
          example: CADOC 5711 - Range Brasil Ltda
          description: Shown in the sidebar and run list. One per regulated entity.
        email:
          type: string
          format: email
          example: compliance@example.com
          description: >-
            Recipient of the workflow report emails, direct. Prefer channel_id
            when the caller has a destination id, not an address — either one's
            required.
        channel_id:
          type: string
          format: uuid
          example: 3f7e2d1a-9c4b-4e5f-8a6d-1b2c3d4e5f6a
          description: >-
            An existing email destination's id (GET /v1/risk/channels). The
            server resolves this to that channel's real recipient address;
            either this or email is required.
        recipients:
          uniqueItems: true
          description: >-
            Existing delivery channel IDs. Omit on PATCH to preserve selections;
            [] clears them. Selected channels receive eligible stored output.
          type: array
          items:
            type: string
            format: uuid
        enabled:
          type: boolean
          example: true
          description: Set false to keep the instance configured but paused.
        report_mode:
          type: string
          enum:
            - always
            - exception_only
          default: always
          description: Delivery policy. Omit on PATCH to preserve the stored mode.
        cadence:
          type: string
          enum:
            - daily
            - monthly
            - event
          example: daily
          description: Defaults to the template cadence.
        formats:
          uniqueItems: true
          example:
            - xml
          description: >-
            Output formats; must be allowed by the template. Defaults to every
            allowed format.
          type: array
          items:
            type: string
        fields:
          type: object
          additionalProperties:
            type: string
          example:
            cnpj: '99999999'
          description: >-
            Template-declared fields, validated against the template
            `field_schema`. Required ones must be present when creating.
    WorkflowInstanceDto:
      type: object
      properties:
        id:
          type: string
          example: 9b2f7c61-2d4e-4a8b-9f10-3c5d7e9a1b2c
        name:
          type: string
          example: CADOC 5711 - Range Brasil Ltda
        email:
          type: string
          example: compliance@example.com
        recipients:
          type: array
          items:
            type: string
            format: uuid
        enabled:
          type: boolean
          example: true
        report_mode:
          type: string
          description: >-
            Stored delivery mode; unsupported legacy values remain unchanged and
            execute as always.
        cadence:
          type: string
          enum:
            - daily
            - monthly
            - event
        formats:
          type: array
          items:
            type: string
        fields:
          type: object
          additionalProperties:
            type: string
          example:
            cnpj: '99999999'
        updated_by:
          type: string
          nullable: true
          example: user@example.com
        created_at:
          type: string
          example: '2026-08-25T00:00:00.000Z'
        updated_at:
          type: string
          example: '2026-08-25T00:00:00.000Z'
      required:
        - id
        - name
        - email
        - recipients
        - enabled
        - report_mode
        - cadence
        - formats
        - fields
        - created_at
        - updated_at
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````