Skip to main content
PATCH
/
api
/
v1
/
accounts
/
{accountId}
/
projects
/
{projectId}
/
widgets
/
{widgetId}
Patch Widget
curl --request PATCH \
  --url https://api.example.com/api/v1/accounts/{accountId}/projects/{projectId}/widgets/{widgetId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "attributes": {}
}
'
{
  "id": "<string>",
  "accountId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "projectId": "<string>",
  "attributes": {},
  "deployments": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "environmentId": "<string>",
      "widgetId": "<string>",
      "accountId": "<string>",
      "widgetConfigurations": [
        {
          "widgetConfigurationId": "<string>",
          "distributionPercentage": 123,
          "widgetConfigurationVersion": 123
        }
      ]
    }
  ],
  "lastWidgetConfigurationVersion": 123,
  "lastDeltaSequenceNumber": 123
}

Path Parameters

accountId
string
required

The ID of the account

projectId
string
required

The ID of the project

widgetId
string
required

The ID of the widget

Body

application/json
name
string
required
attributes
object

JSONB attributes for the widget

Response

id
string
required
accountId
string
required
createdAt
string<date-time>
required
modifiedAt
string<date-time> | null
required
name
string
required
description
string
required
type
string
required
projectId
string
required
attributes
object
deployments
object[] | null
lastWidgetConfigurationVersion
number | null
lastDeltaSequenceNumber
number | null