RESTTypographies

Update Typography

This feature is in Beta and may change. Requests return 403 until the feature flag is enabled for your site or workspace.

Updates a site owned typography by typographyId. All fields are optional; omitted fields keep their current values. “style” replaces the full per-device style array when provided.

Authentication

x-api-keystring
API key authentication. Accepts either: - App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ) - Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Path parameters

idstringRequiredformat: "uuid"
The ID of the typography to update.

Request

This endpoint expects an object.
namestringOptional>=1 character

The name of the typography. A ”/” in the name nests it in a group (e.g. “Headings / H1”); renaming across groups moves it.

stylelist of objectsOptional

Per-device style overrides. Replaces the full style array when provided; per-device entries are not merged. A “color” references an existing swatch by its “id” in “swatchId”; omit or null it for no swatch. “alpha” (0-1) sets opacity.

Response

idstringformat: "uuid"
referenceIdstring

The id to use wherever a text element references this typography (e.g. the “id” field of a Text element’s “typography” prop in a page’s element data) - NOT the plain “id” field above, which is used as the typography identifier in other REST typography api calls.

namestring
stylelist of objects
siteIdstringformat: "uuid"

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error