Skip to main content
PUT
Update a Style Guide (v2)

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

id
string<uuid>
required

Style Guide ID

Query Parameters

name
string
required

Updated name

Maximum string length: 50
description
string

Updated description

Maximum string length: 250
versionChangeReason
string

Optional description of the version change

Maximum string length: 250
includeVersions
boolean
default:false

Whether to include versions in the response

contentGroupId
string
required

Content Group identifier from the Content Group Service.

Minimum string length: 1

Body

file
file

Optional new file to create a new version. Maximum size: 150 KiB.

Response

Metadata-only update completed synchronously

Style Guide information

id
string<uuid>

Unique identifier of the Style Guide

Example:

"018e1234-5678-7890-abcd-ef1234567890"

name
string

Name of the Style Guide (latest version)

Maximum string length: 50
Example:

"English Style Guide"

description
string

Description of the Style Guide (latest version)

Maximum string length: 250
Example:

"Style guide for English content"

language
object

Language details

isDefault
boolean

Whether this is the default Style Guide

Example:

false

createdBy
object

User who created the Style Guide

lastModifiedBy
object

User who last modified the Style Guide

contentGroup
object

Content group associated with this Style Guide

versions
object[]

List of all versions of this Style Guide. Only present when includeVersions=true.

createdAt
string<date-time>

Timestamp when the Style Guide was created

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>

Timestamp when the Style Guide was last modified

Example:

"2024-01-15T10:30:00Z"

extractedRulesCount
integer<int32>

Number of rules extracted and linked to the content group during this create/update operation. Only present for create/update responses when a content group is set; absent otherwise.

Example:

25