v1

latestOpenAPI 3.0.22026-07-261040577.4 KB

Insights

Patch insight

Update an insight's properties. Supports updating the title, custom fields, cover image, and folder location. Only the fields you include in the request body will be modified — omitted fields are left unchanged.

Note: This endpoint is deprecated. Use Patch doc (PATCH /v1/docs/:doc_id) instead.

Note: folder_id and fields cannot be updated in the same request.

Returns the updated insight object.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

patch/v1/insights/{insight_id}

Path parameters

insight_idstring required

Unique identifier of the insight.

Request body

titlestring

The insight's title.

cover_image_file_idstring nullable

Unique identifier of a file to use as the insight's cover image. Set to null to remove the cover image.

folder_idstring nullable

Set the folder for this insight, or null to move it out of a folder. Cannot be combined with fields in the same request.

Example request

{
  "title": "My First Insight"
}

Response

200