v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents

Remove dashboard from document

Remove the dashboard from an existing draft, leaving a workbook-only document. Documents that are already workbook-only will remain unchanged.

Use the Publish draft endpoint to apply the changes from this endpoint to the published version of the document. Note: Schedules will be removed when the document is published.

delete/v2/documents/{documentId}/draft/{draftId}/dashboard

Path parameters

draftIdstring required

Example:def456

ID of the existing draft, created from a successful call to the Create draft and patch document endpoint.

documentIdstring required

Example:abc123

ID of the published document associated with the draft.

Response

Dashboard removed on the draft. The response includes the draftIdentifier.

identifierstring required

Published document identifier the draft targets.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

namestring required

Document name.

descriptionstring nullable required

Document description.

Example response

{
  "identifier": "def456",
  "draftIdentifier": "abc123",
  "name": "Blob Sales",
  "description": "Overview of daily Blobs R Us Sales"
}