Change Document Embed Version

post https://api.lucid.co/documents/{documentId}/embeds/{embedId}/changeVersion

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.

📘
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 Authentication Methods

OAuth 2.0 User Token and Account Token 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

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


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lucid.co/documents/documentId/embeds/embedId/changeVersion \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "embedId": "ec890631-c150-461c-992f-b96533aa05f4",
3
  "documentId": "001bd56d-1b10-4196-8ac6-45e3c22bd1c6",
4
  "embedVersion": "snapshot-version",
5
  "created": "2021-10-01T20:49:36.169Z",
6
  "modified": "2021-10-01T20:49:36.169Z"
7
}

📘

Valid Authentication Methods

OAuth 2.0 User Token and Account Token Scopes:

200OK. Returns a Document Embed Resource containing information about the updated document embed.