Skip to content

Update Variant

PUT
/api/divinity/authored-library/variants/{variant_id}

Update an existing user variant, replacing it in-place.

variant_id
required
Variant Id
string
AuthoredLibraryVariantUpdateRequest

Payload for PUT /variants/{variant_id}.

The situation_key is required alongside the id — user overrides live in per-situation YAML files so we need both to locate the row.

object
situationKey
required
Situationkey
string
text
required
Text
string
tags
Tags
Array<string>
severityFilter
Severityfilter
Array<string>
Allowed values: error warning info
weight
Weight
number
default: 1
isDefault
Isdefault
boolean
engineVersionMin
Engineversionmin
string
default: 0.0.0
genre
Any of:
string

Successful Response

AuthoredLibraryVariantMutationResponse

Response body for any successful variant mutation.

object
variant
required
AuthoredLibraryVariantModel

A single variant as exposed through the API.

source reports whether the variant came from the bundled pack, a user override, or a community pack. source_pack is the filename (bundled) or pack id (community). editorial_status (M15) reports the variant’s shadow-review state — defaults to "approved" for backwards compat with pre-M15 clients.

object
id
required
Id
string
text
required
Text
string
tags
Tags
Array<string>
severityFilter
Severityfilter
Array<string>
Allowed values: error warning info
weight
Weight
number
default: 1
isDefault
Isdefault
boolean
engineVersionMin
Engineversionmin
string
default: 0.0.0
source
required
Source
string
Allowed values: bundled user community
sourcePack
required
Sourcepack
string
genre
Any of:
string
editorialStatus
Editorialstatus
string
default: approved
Allowed values: approved unreviewed flagged
situationKey
required
Situationkey
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object