Produktly docs
Nps widgetsWidgetid

Update an NPS widget

PATCH
/nps-widgets/{widgetId}

Only the fields you send are changed. settings are merged over stored settings; targeting replaces wholesale. Live widgets can be edited, but an update that would leave one unpublishable (no targeting) returns 400; set active: false first to take it down.

Authorization

BearerAuth
AuthorizationBearer <token>

Use an API key from the Produktly dashboard → Settings → API keys.

In: header

Path Parameters

widgetId*integer
Range0 < value

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

curl -X PATCH "https://example.com/nps-widgets/1" \  -H "Content-Type: application/json" \  -d '{    "active": false  }'
{  "id": 0,  "name": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "folderId": 0,  "themeId": 0,  "settings": {    "property1": null,    "property2": null  },  "rules": [    {      "property1": null,      "property2": null    }  ],  "ruleLogicalOperator": "string",  "dashboardUrl": "string",  "note": "string"}