Create Document Embed

post https://api.lucid.co/documents/{id}/embeds

Creates an embed resource associated with a particular document.

The request must be authenticated with an OAuth 2.0 token that has access to the document.

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 create an embed for this document.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lucid.co/documents/id/embeds \
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:

201OK. Returns a Document Embed Resource containing information about the newly created document embed.