Developers
API Reference

Patch insight

patch deprecated
https://dovetail.com/api/v1/insights/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the insight.

Body Params

Body

string
length ≤ 200

The insight's title.

fields
array of objects

The insight's fields.

fields
string | null

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

string | null

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

boolean

When provided, transitions the insight's published state. Passing true publishes the insight (equivalent to clicking Publish in the editor); passing false unpublishes. Triggers notifications and indexing side-effects identical to the in-app flow. Omitting the field leaves the current state unchanged.

Responses

Updated 10 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago