---
title: "Update an existing scenario"
method: PATCH
path: "/v1/org/{orgId}/scenario/{scenarioId}"
tags: ["scenario"]
---

# Update an existing scenario

`PATCH /v1/org/{orgId}/scenario/{scenarioId}`

## Path parameters

- `orgId` string, required
- `scenarioId` string, required

## Query parameters

- `silent` boolean

## Request body

- UpdateScenario
  - `name` string — scenario name
  - `description` string — scenario description
  - `startDate` string, date — date that this scenario diverges from primary
  - `status` 'OPEN' | 'INACTIVE' | 'MERGED' | 'DRAFT' | 'ARCHIVED' — status of scenario
  - `shareAccess` ShareAccess[] — users who are specifically granted permission to this scenario
    - `access` 'NONE' | 'LIMITED_READ' | 'LIMITED_WRITE' | 'STANDARD_READ' | 'STANDARD_WRITE' | 'COMPENSATION_READ' | 'FULL_READ' | 'COMP_PLANNING_PARTICIPANT' | 'COMPENSATION_WRITE' | 'WRITE' | 'COMPENSATION_OWNER' | 'OWNER', required — access permission level
    - `userId` string — user id
    - `groupId` string — group id
    - `fields` string — fields
  - `startDateFixed` 'FIXED' | 'TODAY' — whether or not the start date should stay fixed in time, or update to today's date as time passes
  - `validJobIdSet` string[] — This scenario changes are restricted to the following jobIds
  - `entityId` string — The entity this scenario is associated with
  - `entityType` 'COMP_REVIEW' — The type of entity associated with this scenario
  - `sharedViewConfig` ScenarioSharedViewConfig[] — View configurations associated with this scenario
    - `customColumnNames` string[] — list of column names to display
    - `columnWidths` object — map of column names to widths
    - `type` 'ALL_CHANGES_GROUPED' | 'CREATE' | 'HIRE' | 'DELETE' | 'DEPART' | 'COMP' | 'UPDATE' | 'MOVE' — type of view
    - `updateId` string — update id
    - `updateAt` string — update at
  - `budget` Money
    - `amount` number, required
    - `currency` string, required
    - `places` integer

## Response `204`

scenario updated

## Other responses

- `400` — invalid data
- `401` — not authorized
- `403` — permission denied
- `404` — not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/versions/50a1edd6b27e/schema)