Skip to main content
PATCH
Replace text in the dashboard draft
Changes part of the classic dashboard draft by exact-text replacement, so a small change sends only that change instead of the whole configuration. Read GET /workbooks/{workbookId}/dashboard/file first and copy each oldText from its content, including whitespace. Without replaceAll, oldText must occur exactly once. Edits apply in order; if any one fails, nothing is saved. The result is validated like PUT /workbooks/{workbookId}/dashboard. Returns the new content and hash. Pass expectedHash to get 409 instead of editing a draft that changed since you read it. Requires manage access to the workbook.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
workbookId
number
required

Body

application/json

ReplaceJsonConfigTextInput

edits
object[]
required

Replacements applied in order, each to the result of the previous one. Either all apply or nothing is saved.

Required array length: 1 - 50 elements
expectedHash
string | null

The hash from your last read. When set, the request fails with 409 if the configuration changed since then.

Pattern: ^[a-f0-9]{64}$

Response

200 - application/json
content
string
required

The configuration as canonical JSON text: keys sorted, 2-space indentation, trailing newline. oldText in a replacement must match this text exactly.

hash
string
required

SHA-256 of content. Send it back as expectedHash to reject the write if the configuration changed since you read it.