Surveys - Edit NPS

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/surveys/nps/edit

Updates an existing NPS widget.

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Parameter	Type	Required	Description
`api_key`	String	Yes (or `auth_token`)	API key authentication
`auth_token`	String	Yes (or `api_key`)	Auth token authentication
`app_id`	String	Yes	App ID
`widget_id`	String	Yes	Widget ID
`msg`	String (JSON Object)	No	NPS message config
`appearance`	String (JSON Object)	No	Appearance config
`status`	Boolean/String	No	Active status
`followUpType`	String	No	Follow-up mode

/i/surveys/nps/edit?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID&widget_id=67b9db56f67aab0012cd8899&name=NPS Q2

{
  "result": "Success"
}

Field	Type	Description
`result`	String	Update status

{
  "result": "Invalid params: ..."
}

{
  "result": "Widget not found"
}

Parses and preprocesses widget properties such as msg, appearance, and targeting.
Updates feedback_widgets by widget_id. Appearance fields are stored under appearance.<field>.
If delete_logo is set and no new logo file is uploaded, deletes the stored logo and clears appearance.logo.
If targeting changes, updates, creates, or deletes the linked cohort and recalculates cohort steps when needed.
Returns Success after widget/cohort updates, or specific cohort/upload error messages when follow-up work fails.
Emits surveys_widget_edited and, when applicable, cohort_edited system log actions.

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
`countly.feedback_widgets`	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
`countly.cohorts`	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.