These docs are for v1.0. Click to read the latest docs for v1.2.

Change Document Embed Version

Updates the version type of an existing document embed. Calling this endpoint with an embedVersion of "snapshot-version" will associate the existing embed with a snapshot of the current state of the document, even if the embed was already associated with an older snapshot of the document. It supports both Account and User token types.

📘

Updating the version of an existing document embed with version type snapshot-version can't be undone! There is no way to revert an embed to a previous snapshot version.

Valid Access Token Types

Account

User

Valid Access Scopes

lucidchart.document.content.share.embed

lucidchart.document.app.picker.share.embed

lucidscale.document.content.share.embed

lucidscale.document.app.picker.share.embed

lucidspark.document.content.share.embed

lucidspark.document.app.picker.share.embed

Path Params
uuid
required

ID of the embedded document to retrieve.

uuid
required

ID of the document embed to retrieve.

Body Params
string

Determines what version of the document will be loaded in the document viewer.

Headers
string
required
Defaults to 1

The API version used in the request.

Responses

400

Bad Request. Occurs if the embed version provided in the request body is invalid.

403

Forbidden. Occurs when the access token isn't allowed to change the embed version.

Language
Credentials
OAuth2