TRtraceroot
Widgets

Edit a dashboard widget

Edit a widget's title, spec, or display config.

Requires MEMBER role or higher in the project's workspace (the write service decides). A sent spec replaces the whole spec and is checked against the widget's stored type by the service; type is immutable.

Args: request (Request): Incoming request (rate-limit plumbing). response (Response): Outgoing response (rate-limit plumbing). auth (AccountStampedAuth): Account-scope user auth (session token or CLI access JWT); its resolved user_id becomes the actor. widget_id (str): The widget to edit. payload (UpdateWidgetRequest): The project and the fields to change. _live (None): Write-path liveness gate (blocks a revoked JWT session).

Returns: UpdateWidgetResponse: The updated widget and the changed fields.

Raises: HTTPException: The write service's 400/403/404 verbatim, or a 503 when its response is ambiguous.

patch/api/v1/public/widgets/{widget_id}

Request

  • Base URL
    https://app.traceroot.ai
  • URL
    https://app.traceroot.ai/api/v1/public/widgets/{widget_id}
  • Auth
    HTTP bearer

Path parameters

widget_idstring required

Request body

display_configobject nullable

Replaces the whole display config; null resets it to {}

project_idstring required
titlestring

Response

Successful Response

changedstring[] required
updatedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.