---
title: "Update allocation rule"
method: PATCH
path: "/v1/cost-allocation/{id}/rules/{ruleId}"
tags: ["Cost allocation"]
---

# Update allocation rule

`PATCH /v1/cost-allocation/{id}/rules/{ruleId}`

## Request

- Base URL: `https://api.nops.io`
- URL: `https://api.nops.io/v1/cost-allocation/{id}/rules/{ruleId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nops/apis/nops-public-api/docs/v1/cost-allocation/:id/rules/:ruleId/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required: Showback ID
- `ruleId` string, required: Rule ID

## Headers

- `Idempotency-Key` string, required: Unique key for safe retries on write requests (required, max 64 characters).

## Request body

- object
  - `name` string
  - `showbackValue` string
  - `filters` object[]
    - `dimension` string, required
    - `mode` 'include' | 'exclude', required
    - `values` string[], required
    - `valueModes` object
    - `texts` object[]
      - `mode` 'include' | 'exclude', required
      - `text` string, required
    - `textCombinator` 'and' | 'or'
    - `keyCombinator` 'and' | 'or'
    - `tagKeyOnly` boolean
    - `includePreAttributionHistory` true
  - `active` boolean
  - `distributionByPercent` boolean
  - `percentageAllocationType` 'BY_SPEND' | 'CUSTOM_PERCENT' | 'CUSTOM_BY_SPEND' | 'EVENLY'
  - `costDistribution` object
  - `dimensionFilters` object[]
    - `dimension` string, required
    - `mode` 'include' | 'exclude', required
    - `values` string[], required
    - `valueModes` object
    - `texts` object[]
      - `mode` 'include' | 'exclude', required
      - `text` string, required
    - `textCombinator` 'and' | 'or'
    - `keyCombinator` 'and' | 'or'
    - `tagKeyOnly` boolean
    - `includePreAttributionHistory` true
  - `clearDimensionFilter` boolean

## Response `200`

Update allocation rule

- object
  - `data` object, required: JSON object

## Other responses

- `401`: Unauthorized — invalid or missing API key
- `403`: Forbidden — insufficient permissions or entitlement

---

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