Update a workbook, or stop its running queries

PUT 
/workbooks/:workbook_id

Has two modes, selected by the action query parameter. The caller needs editor access or higher on the workbook.

• Without action: updates the workbook. Every body property is optional and an empty body is a valid no-op that still returns 200. Properties are written only when the supplied value differs from the stored one, except ExpireAfter, which always rewrites the expiry from the current time. Setting Title also sets IsTitleUpdated to true, which stops auto-generation from later overwriting it.

• action=stop_running_queries: aborts all in-flight queries belonging to the workbook. The request body is ignored entirely in this mode.

Unlike GET on the same path, an unrecognised action value is rejected here with IPV-1004.

Note that an unknown workbook id is reported as HTTP 400 with IPV-1002, not 404.

Request

Responses

200

Workbook updated, or stop requests issued when action=stop_running_queries.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

Input validation or authorization failure. Body is {"Message": " - "}. Codes: GE-1001 (body present but unparseable), IPV-1002 (workbook id not found), IPV-1004 (invalid action, Title, IsPinned, AutoGenerateTitle, ExpireAfter, or any chat or query configuration violation), AUTH-1012 (the caller lacks editor access), AUTH-1010 (ChatConfiguration RoleId is not a role the caller is attached to).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Something went wrong at backend

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers