Update a style guide

patch

https://api.lingohub.com/v2/style-guides/{styleGuideId}

Partially updates the style guide identified by the given ID (JSON merge-patch). Only fields present in the request body are changed; omitted fields are left unchanged. name cannot be null; a null value for any other field clears it — string fields are cleared and enum fields are reset to NOT_SPECIFIED. Returns the full updated style guide. For creating, updating, or deleting language_rules see the /v2/style-guides/:languageId/rules endpoint.
Requires workspace-level style guide management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

styleGuideId

string

required

^sg_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Unique identifier of the style guide.

Body Params

Request body to partially update a LingoHub style guide (PATCH, JSON merge-patch). Omitted fields are left unchanged. name and rules cannot be null; ai_context and audience_description may be set to null to clear them, and each rule inside rules may be set to null to reset it to NOT_SPECIFIED.

name

string

length between 2 and 128

Display name of the style guide.

ai_context

string | null

Additional context provided to the AI to guide translation style and tone.

audience_description

string | null

Description of the target audience for this style guide.

rules

object

Style rules to change (JSON merge-patch): omitted rules are left unchanged, a rule set to null is reset to NOT_SPECIFIED.

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Style guide updated successfully.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404Style guide not found.

412The current representation does not match If-Match (precondition_failed). No change was applied.

422Validation error.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.