Update a Forward Insight
/insights/{insight_id}Renames a Forward Insight or changes its description. The numbers on its card stay as they are.
Scope | Heavy call | Long poll | CLI |
|---|---|---|---|
| No | No |
|
Guidance
Send
name,descriptionor both. A body with neither answers400 invalid_request.To change the numbers or the breakdown, change the study, run it again and call Create a Forward Insight with the same
name. It replaces this one.The new name shows on the chart card and in the definition's Forward Insights tab.
Path parameters
Name | Type | Description |
|---|---|---|
| string | The insight's id, such as |
Request body
At least one field.
Field | Type | Required | Description |
|---|---|---|---|
| string | No | New name, 1 to 120 characters |
| string | No | New description, at most 2,000 characters. |
Response
200 with the updated Forward Insight.
Status codes
Status | Code | Meaning |
|---|---|---|
| - | The change was made |
|
| The body is not JSON or has neither field, |
|
| No active insight with that id on your account |
|
| The change failed. Retry |
