LUlucid
Document Access

Admin Update Document

Changed on

Allows account admins to update custom tags and classification on any document in their account.

patch/v1/accounts/me/documents/{id}

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopeslucidchart.document.content:admin, lucidscale.document.content:admin, lucidspark.document.content:admin, lucid.document.content:admin

Path parameters

idstring uuid required

ID of the document to update.

Request body

customTagsstring[]

List of custom tags to assign to the document. Including this field overwrites all existing tags on the document with the provided values. Each tag must be non-empty and must not start or end with whitespace. Omitting this field leaves existing tags unchanged; set to an empty array to clear all tags.

classificationIdstring uuid nullable

ID of the classification to assign to the document. Omitting this field leaves the existing classification unchanged; set to null to remove the classification.

Example request

{
  "customTags": [
    "in progress"
  ],
  "classificationId": "1cdad938-bf0f-4a0c-a2f8-bf4eb94225ce"
}

Response

OK with Document resource containing information about the updated document.

documentIdstring uuid required

Unique ID of the document

titlestring required

Title of the document

editUrlstring uri required

Link to edit the document

viewUrlstring uri required

Link to view the document

versioninteger required

Most recent version

pageCountinteger required

Number of pages within the document

canEditboolean required

If requesting user can edit the document

createdstring date-time required

Date and time of when the document was created

creatorIdinteger required

ID of user who created and owns the document

lastModifiedstring date-time required

Date and time of when the document was last modified

lastModifiedUserIdinteger required

ID of user who most recently modified the document

customTagsstring[] required

List of any custom tags assigned to the document

product'lucidchart' | 'lucidscale' | 'lucidspark' required

The Lucid Suite product that a document was created in.

statusstring nullable

Current assigned status of the document

classificationstring nullable

Current assigned classification of the document

classificationIdstring uuid nullable

Current assigned classification ID of the document.

trashedstring date-time nullable

If defined, the timestamp when the document was moved to the trash

parentinteger nullable

ID of the parent folder

accountIdinteger nullable required

ID of Lucid account that owns the document

Example response

{
  "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
  "title": "document title",
  "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",
  "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",
  "version": 101,
  "pageCount": 5,
  "canEdit": false,
  "created": "2019-04-22T13:47:23Z",
  "creatorId": 12345,
  "lastModified": "2020-06-26T16:29:37Z",
  "lastModifiedUserId": 54321,
  "customAttributes": [],
  "customTags": [
    "in progress"
  ],
  "product": "lucidchart",
  "status": "Complete",
  "classification": "Private",
  "trashed": null,
  "parent": null,
  "repository": null,
  "owner": {
    "id": 123456,
    "type": "user",
    "name": "John Doe"
  },
  "accountId": 1234
}

Changes