API Reference

Save an input-widget config value on a shared dashboard

PUT /api/public/dashboards/{token}/widgets/{widgetId}/config

Mirror of PUT /api/dashboards/{id}/widgets/{widgetId}/config. Gated by the kill switch (503) and allow_public_input (403). Writes use updated_by='public'.

Operation IDsavePublicDashboardWidgetConfig

Authentication

No authentication is required.

Path parameters

tokenstringrequired

widgetIdstringrequired

Request body

This request body is required.

Content typeapplication/json

requestobject

1 property

valueunknownrequired

Persisted value for the widget. field_mapping → array of { source_field, target_field, transform? }; form → object keyed by field key.

Success response body

200Saved

Saved

Content typeapplication/json

responseobject

1 property

okboolean

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

403Public input not enabled for this dashboard

Public input not enabled for this dashboard

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

503Public dashboard input disabled on this server

Public dashboard input disabled on this server

No response content schema is documented.

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/YOUR_WIDGET_ID/config' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/YOUR_WIDGET_ID/config", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "value": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);