Skip to main content
PATCH
Rename a scenario and/or replace its description

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Path Parameters

id
string<uuid>
required

scenario_id

Body

application/json
name
string
Maximum string length: 100
description
string | null
Maximum string length: 2000
clear_description
boolean

Alias for sending description: null. Set true to clear an existing description.

Response

The scenario was updated

success
boolean
scenario
object

The full scenario record, as returned by create/rename (distinct field names from the Scenario list-view above; id, not scenario_id).