---
title: "Rule definitions (write — PUT)"
method: PUT
path: "/api/rule-definitions"
tags: ["Rules"]
---

# Rule definitions (write — PUT)

`PUT /api/rule-definitions`

## Request

- Base URL: `https://api.kiloiot.io`
- URL: `https://api.kiloiot.io/api/rule-definitions`
- Auth: API key in header `X-API-Key` and API key in header `X-Organization-Id`

Update rule definitions. Endpoints: PUT /api/rule-definitions/{id} (update name/description), PUT /api/rule-definitions/{id}/save (save BPMN progress).

**Required scope:** `rules:write`

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string

## Response `200`

OK

- object
  - `ruleDefinition` object
    - `id` string
    - `name` string
    - `description` string
    - `organizationId` string
    - `authorId` string
    - `version` integer
    - `createdAt` string
    - `updatedAt` string

## Other responses

- `401`: Missing or invalid API key
- `403`: Insufficient permissions (missing required scope)

---

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