Update Style Guide
PUT /api/creative/edit/style-guides/{guide_id}
PUT
/api/creative/edit/style-guides/{guide_id}
Update a custom style guide.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” guide_id
required
Guide Id
string
Request Body required
Section titled “Request Body required ” UpdateStyleGuideRequest
Request to update an existing style guide.
object
rules
Any of:
Array<object>
StyleGuideRuleA single rule within a style guide.
object
id
required
Id
Rule ID
string
category
required
Category
Rule category: punctuation, capitalization, terminology, etc.
string
description
required
Description
What the rule requires
string
exampleCorrect
required
Examplecorrect
Correct usage example
string
exampleIncorrect
required
Exampleincorrect
Incorrect usage example
string
null
Responses
Section titled “ Responses ”Successful Response
StyleGuide
A style guide with its rules.
object
id
required
Id
Guide ID
string
projectId
required
Projectid
Project this guide belongs to
string
name
required
Name
Display name
string
guideType
required
StyleGuideType
Guide type
string
rules
Rules
Array<object>
StyleGuideRuleA single rule within a style guide.
object
id
required
Id
Rule ID
string
category
required
Category
Rule category: punctuation, capitalization, terminology, etc.
string
description
required
Description
What the rule requires
string
exampleCorrect
required
Examplecorrect
Correct usage example
string
exampleIncorrect
required
Exampleincorrect
Incorrect usage example
string
isActive
Isactive
Whether this guide is currently active
boolean
createdAt
required
Createdat
Unix timestamp
integer
modifiedAt
required
Modifiedat
Unix timestamp
integer
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context