ChartnautDocs

Update a Forward Insight

PATCH/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

scripts:write

No

No

chartnaut insights update

Guidance

  • Send name, description or both. A body with neither answers 400 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

insight_id

string

The insight's id, such as ins_842

Request body

At least one field.

Field

Type

Required

Description

name

string

No

New name, 1 to 120 characters

description

string

No

New description, at most 2,000 characters. "" clears it

Response

200 with the updated Forward Insight.

Status codes

Status

Code

Meaning

200

-

The change was made

400

invalid_request

The body is not JSON or has neither field, name is empty or too long, or description is too long

404

not_found

No active insight with that id on your account

502

internal

The change failed. Retry