> ## 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.31 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. - name: Parties description: >- The workspace entity register: the firm itself, its clients, and its counterparties. 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. channel_id: type: string format: uuid example: 3f7e2d1a-9c4b-4e5f-8a6d-1b2c3d4e5f6a description: >- Optional single delivery channel ID. Prefer recipients for multiple destinations; if both are supplied their IDs are combined. On PATCH, channel_id alone replaces every stored selection. recipients: uniqueItems: true description: >- Optional delivery channel IDs; create without destinations and configure them later. 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. cadence: type: string enum: - daily - monthly - manual - 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: oneOf: - type: string - type: boolean - type: object additionalProperties: type: boolean example: cnpj: '99999999' description: >- Template-declared fields, validated against field_schema. Required fields must be present on create. PATCH merges top-level fields; stablecoin_overrides replaces the whole map, and {} clears it. CADOC 5711 accounting switches default to false. Override keys use exact, case-sensitive network|denom identity. WorkflowInstanceDto: type: object properties: id: type: string example: 9b2f7c61-2d4e-4a8b-9f10-3c5d7e9a1b2c name: type: string example: CADOC 5711 - Range Brasil Ltda recipients: type: array items: type: string format: uuid enabled: type: boolean example: true cadence: type: string enum: - daily - monthly - manual - event formats: type: array items: type: string fields: type: object additionalProperties: oneOf: - type: string - type: boolean - type: object additionalProperties: type: boolean example: cnpj: '99999999' updated_by: type: string nullable: true example: user_123 description: >- Authenticated user ID or API-key fingerprint for new mutations. Historical values are retained unchanged. created_at: type: string example: '2026-08-25T00:00:00.000Z' updated_at: type: string example: '2026-08-25T00:00:00.000Z' state: type: string enum: - active - paused - running - failed - delivery_failed description: >- Derived from `enabled` and the most recent run: a disabled instance is always `paused`. last_run: nullable: true description: The most recent run, or null if the instance never ran. type: object allOf: - $ref: '#/components/schemas/WorkflowLastRunDto' backfill_summary: type: string nullable: true description: >- Present on a redemption monitor. One sentence recording how many redemptions were already past their deadline when monitoring started and were stored without a case. required: - id - name - recipients - enabled - cadence - formats - fields - created_at - updated_at - state - last_run WorkflowLastRunDto: type: object properties: id: type: string example: 1f0c8b3a-5d6e-4f70-8192-a3b4c5d6e7f8 execution_status: type: string enum: - queued - running - succeeded - failed - cancelled - skipped delivery_status: type: string enum: - not_required - pending - sending - sent - failed - cancelled created_at: type: string example: '2026-09-01T02:59:00.000Z' required: - id - execution_status - delivery_status - created_at securitySchemes: Authorization: type: apiKey in: header name: X-API-KEY description: Authorization method required to allow user to access the api endpoints. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.