# Change a judging rule

PATCH

/v1/projects/{projectId}/judging-rules/{ruleId}

```sh
curl --request PATCH \
  --url https://example.com/v1/projects/example/judging-rules/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "when": { "agentIds": [ "example" ], "flowIds": [ "example" ], "versions": [ "example" ], "status": [ "completed" ], "includeDryRuns": true }, "sample": 1, "maxOpen": 1, "judgeClassId": "example", "enabled": true }'
```

A new version with these fields changed (`when` is replaced whole). Earlier versions are kept: `…/versions` shows who changed what, when. Needs `write` on the project.

## Authorizations

- **[bearerAuth](https://docs.kindgi.com/v0.1.9/reference/api.md#bearerauth)**

## Parameters

### Path Parameters

**projectId**

required

string

ProjectId — opaque branded string.

**ruleId**

required

string

## Request Bodyrequired

application/json

The fields to change; `when` is replaced whole.

object

**name**

string

\>= 1 characters <= 200 characters

**when**

Which of a project’s runs a rule matches as they end. Every field narrows; absent fields don’t. `agentIds` or `flowIds`, not both. Top-level runs only (an agent’s own runs, not its turns as a flow’s step); replays never match.

object

**agentIds**

Array\<string>

\>= 1 items <= 50 items

**flowIds**

Array\<string>

\>= 1 items <= 50 items

**versions**

These versions exactly, or `live`: runs that got the agent’s live version, not one the caller named. Runs from before the runtime recorded how their version was chosen never match `live`.

Array\<string>

\>= 1 items <= 50 items

**status**

How the run ended. Only `completed` today: a judgment needs a completed run, so `failed` and `cancelled` are refused (400). Absent: `completed`.

Array\<string>

\>= 1 items

Allowed values: completed failed cancelled

**includeDryRuns**

Dry runs are left out unless `true`.

boolean

**sample**

The share of matching runs queued, decided by the run and rule ids: the same every time and across the rule’s versions, so raising it keeps the runs it took before. Default 1.

number

\> 0 <= 1

**maxOpen**

Queue nothing while this rule has this many open items. `null` removes the cap.

integer | null

\>= 1 <= 10000

**judgeClassId**

Whose judgment it wants: one of this class closes it. `null`: any judgment does.

string | null

**enabled**

Default `true`.

boolean

## Responses

### 200

The new version.

application/json

One version of a judging rule; the latest live one applies.

object

**ruleId**

required

string

**projectId**

required

string

**version**

required

integer

\>= 1

**name**

required

string

\>= 1 characters <= 200 characters

**when**

required

Which of a project’s runs a rule matches as they end. Every field narrows; absent fields don’t. `agentIds` or `flowIds`, not both. Top-level runs only (an agent’s own runs, not its turns as a flow’s step); replays never match.

object

**agentIds**

Array\<string>

\>= 1 items <= 50 items

**flowIds**

Array\<string>

\>= 1 items <= 50 items

**versions**

These versions exactly, or `live`: runs that got the agent’s live version, not one the caller named. Runs from before the runtime recorded how their version was chosen never match `live`.

Array\<string>

\>= 1 items <= 50 items

**status**

How the run ended. Only `completed` today: a judgment needs a completed run, so `failed` and `cancelled` are refused (400). Absent: `completed`.

Array\<string>

\>= 1 items

Allowed values: completed failed cancelled

**includeDryRuns**

Dry runs are left out unless `true`.

boolean

**sample**

required

number

\> 0 <= 1

**maxOpen**

Queue nothing while this rule has this many open items. Absent: no cap.

integer

\>= 1 <= 10000

**judgeClassId**

Whose judgment it wants: one of this class closes it. Absent: any judgment does.

string

**enabled**

required

boolean

**createdBy**

Who wrote this version.

string

**createdAt**

required

string format: date-time

**unregisteredAt**

string format: date-time

##### Example

```json
{
  "when": {
    "status": [
      "completed"
    ]
  }
}
```

### 400

Malformed request body.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 401

Missing / malformed / expired / revoked bearer token.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 404

No such rule (`judging-rule-not-found`), or no live judge class `judgeClassId` (`judge-class-not-found`).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 409

Idempotency-Key was reused with a different body, or resource-state conflict.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 413

The request body is over the API’s limit (`request-too-large`; `details.maxBytes` says how much).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 500

Server error (unmapped domain code or framework crash).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

## See also

- [`GET /v1/projects/{projectId}/judging-rules/{ruleId}`: Fetch a judging rule](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsjudgingrulesget.md)
- [`GET /v1/projects/{projectId}`: Fetch a project by id](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsget.md)
- [`PATCH /v1/projects/{projectId}`: Partially update a project](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsupdate.md)
- [`DELETE /v1/projects/{projectId}`: Delete a project (idempotent)](https://docs.kindgi.com/v0.1.9/reference/api/operations/projectsdelete.md)
- [Error code `judge-class-not-found`](https://docs.kindgi.com/v0.1.9/reference/errors.md#judge-class-not-found)
- [Error code `judging-rule-not-found`](https://docs.kindgi.com/v0.1.9/reference/errors.md#judging-rule-not-found)
- [Error code `request-too-large`](https://docs.kindgi.com/v0.1.9/reference/errors.md#request-too-large)
- [Every error code](https://docs.kindgi.com/v0.1.9/reference/errors.md)