API referenceEndpoints

Refresh a widget

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/widgets/inbound/http.go`.

POST/v1/widgets/{id}/refresh

Requires an authenticated tenant principal. Generated from the production route registered in internal/features/widgets/inbound/http.go.

Authorization

bearerAuth
AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key*string

Required, at most 200 bytes. This route takes no body, so a replay with the same key always returns the original refresh job unchanged. Five operations share one receipt table keyed per widget (widget_operations) — draft open/restore, update-source, a draft message, a view, and refresh itself — so reusing a key already used for a DIFFERENT one of those five is 409 {"error":{"type":"conflict","code":"idempotency_key_reuse","message":"widget changed or preview is no longer current"}}. POST /v1/widgets (create) and .../draft/publish keep their own separate key columns and are unaffected by this route's key.

Lengthlength <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/widgets/497f6eca-6276-4993-bfeb-53cbbbba6f08/refresh" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}

List parameter options

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/widgets/inbound/http.go`.

List revisions

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/widgets/inbound/http.go`.