Skip to main content
PATCH
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
/
documents
/
{documentPath}
Update document
curl --request PATCH \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "content": "<string>",
  "type": "workbook",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>",
  "metadata": {}
}
'
{
  "path": "<string>",
  "content": "<string>",
  "type": "workbook",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
workspaceName
string
required

The unique identifier of the workspace Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
documentPath
string
required

The path to the document within the workspace Path pattern supporting slashes, dots, and dashes

Pattern: ^[a-zA-Z0-9_/.-]+$

Body

application/json

Represents a document within a workspace, such as a workbook or dashboard

​
path
string

The file path of the document within the workspace

Pattern: ^[a-zA-Z0-9_/.-]+$
​
content
string

The content of the document, typically Malloy code or configuration

​
type
enum<string>

The type of document, determining its purpose and behavior

Available options:
workbook,
dashboard,
modeling_chat,
data_chat,
agent_report
​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the document was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the document was last modified

​
modifiedBy
string | null

The userId of the user who last modified this document

​
metadata
object

Optional JSON metadata associated with the document (e.g. title, tags)

Response

Document updated successfully

Represents a document within a workspace, such as a workbook or dashboard

​
path
string

The file path of the document within the workspace

Pattern: ^[a-zA-Z0-9_/.-]+$
​
content
string

The content of the document, typically Malloy code or configuration

​
type
enum<string>

The type of document, determining its purpose and behavior

Available options:
workbook,
dashboard,
modeling_chat,
data_chat,
agent_report
​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the document was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the document was last modified

​
modifiedBy
string | null

The userId of the user who last modified this document

​
metadata
object

Optional JSON metadata associated with the document (e.g. title, tags)