---
title: "Update the convention — casing, separator, required parameters, mode; a field left out keeps its value"
method: PUT
path: "/api/v1/rules/convention"
tags: ["rules"]
---

# Update the convention — casing, separator, required parameters, mode; a field left out keeps its value

`PUT /api/v1/rules/convention`

## Request

- Base URL: `https://app.utmkit.co`
- URL: `https://app.utmkit.co/api/v1/rules/convention`
- Auth: HTTP bearer

Requires a token with the `rules:write` permission.

## Request body

- ConventionInput: Partial by design: unnamed rules are left alone.
  - `casing` 'lower' | 'upper' | 'any'
  - `mode` 'block' | 'warn'
  - `required_parameters` string[]
  - `separator` 'hyphen' | 'underscore' | 'any'

## Response `200`

Convention

- Convention
  - `casing` string
  - `mode` 'block' | 'warn'
  - `required_parameters` string[]
  - `separator` string

## Other responses

- `422`: Error

---

[API](https://skmtc.dev/utmkit/apis/utmkit-api.md) · [All operations](https://skmtc.dev/utmkit/apis/utmkit-api/llms.txt) · [OpenAPI document](https://skmtc.dev/utmkit/apis/utmkit-api/revisions/74266a7b244a?raw)