Skip to main content
PATCH
/
insights
/
{id}
Update insight
curl --request PATCH \
  --url https://productlane.com/api/v1/insights/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>",
  "title": "<string>",
  "painLevel": "UNKNOWN",
  "projectId": "<string>",
  "notify": {
    "slack": true,
    "email": true
  },
  "state": "NEW"
}'
"<any>"

Update Insight

Update an existing insight by its ID. All fields are optional and only provided fields will be updated.

Path Parameters

id
string
required
Unique identifier of the insight to update

Request Body

text
string
Insight content (minimum 1 character). Can be HTML formatted for line breaks, lists, formatting and headings.
title
string
Insight title
painLevel
string
Pain level associated with this insight
projectId
string
ID of the project this insight is related to
notify
object
Notification preferences
notify.slack
boolean
Whether to send Slack notification
notify.email
boolean
Whether to send email notification
state
string
New state for the insight

Response

id
string
Unique identifier for the updated insight
text
string
Insight content
title
string
Insight title
painLevel
string
Pain level of the insight
origin
string
Source of the insight
contactEmail
string
Email of the contact who provided the insight
contactName
string
Name of the contact who provided the insight
projectId
string
ID of the related project
issueId
string
ID of the related issue
state
string
Current state of the insight
createdAt
string
Timestamp when the insight was created
updatedAt
string
Timestamp when the insight was last updated
workspaceId
string
ID of the workspace this insight belongs to

Example Request

{
  "text": "Updated: The dashboard has been redesigned with better navigation and clearer metrics organization.",
  "title": "Dashboard Navigation - Resolved",
  "painLevel": "LOW",
  "state": "COMPLETED",
  "projectId": "proj_123"
}

Example Response

{
  "id": "insight_123456789",
  "text": "Updated: The dashboard has been redesigned with better navigation and clearer metrics organization.",
  "title": "Dashboard Navigation - Resolved",
  "painLevel": "LOW",
  "origin": "API",
  "contactEmail": "john@acme.com",
  "contactName": "John Doe",
  "projectId": "proj_123",
  "issueId": null,
  "state": "COMPLETED",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T11:45:00Z",
  "workspaceId": "ws_123456789"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
text
string
Minimum length: 1
title
string
painLevel
enum<string>
Available options:
UNKNOWN,
LOW,
MEDIUM,
HIGH
projectId
string
notify
object
state
enum<string>
Available options:
NEW,
PROCESSED,
COMPLETED,
SNOOZED,
UNSNOOZED

Response

Successful response

The response is of type any.

I