---
title: "Update a file rename rule"
method: PATCH
path: "/api/end_user_files/rename_rules/{heron_id}"
tags: ["EndUserFiles"]
---

# Update a file rename rule

`PATCH /api/end_user_files/rename_rules/{heron_id}`

Update an existing rename rule identified by its `heron_id`.

## Path parameters

- `heron_id` string, required

## Request body

- UpdateFileRenameRuleSchema
  - `file_name_template` string, required
  - `is_enabled` boolean, required
  - `variables` VariableDefinition[]
    - `description` string, required
    - `examples` string[], required
    - `key` string, required
    - `name` string, required

## Response `200`

The updated file rename rule

- GetFileRenameRulesSchema
  - `end_user_file_class` string, required
  - `file_name_template` string, required
  - `heron_id` string
  - `is_enabled` boolean, required
  - `variables` VariableDefinition[]
    - `description` string, required
    - `examples` string[], required
    - `key` string, required
    - `name` string, required

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)