Pages

Update a widget

This route allows you to update a specific widget in your portal. <br/><br/>To learn more about pages, checkout the documentation.

patch/v1/pages/{page_identifier}/widgets/{widget_id}

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/pages/{page_identifier}/widgets/{widget_id}
  • Auth: API key in header Authorization

Path parameters

page_identifierstring required

The unique identifier of the page the widget belongs to.

widget_idstring required

The unique identifier of the widget you want to update.

Request body

object required

Partial update for an existing widget. Allowed keys depend on the stored widget type; see the Create a widget endpoint to find out which properties are available for each widget type. type and id cannot be changed. Use null to clear a property.

Example request

{
  "title": "Updated widget title"
}

Response

Updated successfully

okunknown required
identifierstring required

Changes

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