---
title: "Create a file rename rule"
method: POST
path: "/api/end_user_files/rename_rules"
tags: ["EndUserFiles"]
---

# Create a file rename rule

`POST /api/end_user_files/rename_rules`

Add a new rename rule for files.

## Request body

- CreateFileRenameRuleSchema
  - `end_user_file_class` string, required
  - `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 created 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.net/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.net/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)