Skip to main content
PATCH
/
v0
/
widgets
/
{widget_id}
Update Widget
curl --request PATCH \
  --url https://api.sumvin.com/v0/widgets/{widget_id} \
  --header 'Content-Type: application/json' \
  --header 'x-sumvin-pat: <api-key>' \
  --data '
{
  "title": "<string>"
}
'
{
  "_links": {},
  "id": "<string>",
  "type": "<string>",
  "position": 123,
  "created_at": 123,
  "updated_at": 123,
  "query_config": {},
  "display_config": {},
  "deleted_at": 123
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Path Parameters

​
widget_id
string
required

Body

application/json
​
title
string | null

Widget display title

Maximum string length: 255
​
size
enum<string> | null

Widget size for dashboard layout

Available options:
small,
medium,
large

Response

Widget updated successfully

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
id
string
required
​
type
string
required
​
position
integer
required
​
created_at
integer
required
​
updated_at
integer
required
​
query_config
Query Config · object
​
display_config
Display Config · object
​
deleted_at
integer | null