Skip to content

updateWidgetPreviewImage

PUT
/api/v1/widgets/{id}/preview-image

Stores the frozen image captured from the actual Widget editor render. Requires an editor-capable dashboard session and CSRF token. The server accepts only a 960 by 540 JPEG no larger than 500 KB; Widget configuration updates clear the prior snapshot so stale renders are never shown.

Media typeimage/jpeg
string format: binary
<= 512000 characters

Widget preview image stored

Widget not found

Preview image exceeds 500 KB

Preview is not a valid 960 by 540 JPEG