---
title: "Update Custom Rule"
method: PUT
path: "/api/v1/custom-rules/{rule_id}"
tags: ["custom-rules"]
---

# Update Custom Rule

`PUT /api/v1/custom-rules/{rule_id}`

## Request

- Base URL: `https://app.kaminari.ad`
- URL: `https://app.kaminari.ad/api/v1/custom-rules/{rule_id}`
- Auth: HTTP bearer

Update a custom tag rule.

## Path parameters

- `rule_id` string, uuid, required

## Request body

- UpdateCustomRuleRequest: Request body for PUT /custom-rules/{id}. All fields optional.
  - `name` string, nullable
  - `tag_slug` string, nullable
  - `config` object, nullable
  - `target` string, nullable
  - `is_active` boolean, nullable
  - `tag_visibility` object, nullable

## Response `200`

Successful Response

- CustomRuleResponse: Custom tag rule returned by API.
  - `id` string, uuid, required
  - `organization_id` string, uuid, nullable, required
  - `name` string, required
  - `tag_slug` string, required
  - `rule_type` string, required
  - `config` object, required
  - `target` string, required
  - `is_active` boolean, required
  - `created_at` string, date-time, required
  - `scope` string
  - `tag_visibility` object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/kaminari/apis/kaminari-ad-api.md) · [All operations](https://skmtc.dev/kaminari/apis/kaminari-ad-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kaminari/apis/kaminari-ad-api/revisions/013f86e2fd32?raw)
