Update insight status

put

https://api.ocrolus.com/v2/book/{book_uuid}/insights/{insight_uuid}/status

Discards, un-discards, or reviews one insight on a Book, and returns the updated insight in the same shape its group uses in the List insights response.

The status you send is the disposition to apply, not the resulting status. To learn more, see the Insights guide.

📘
Note

Requires update access to the Book.

Reviewed is final. Once an insight is Resolved, every further status change returns 400.

Status changes are last-writer-wins. If another writer changed the insight first, this request still returns 200, so compare the returned status with the one you sent.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Success. The response has the shape of the insight's group, selected by insight_source. See the Ocrolus insight schema for discrepancy, and the AUS finding schema for aus. The examples show the result of each status change, using the same shape.

400Bad Request. One or more of the required fields is missing or invalid.

401Unauthorized. The access token is missing or invalid.

403Forbidden. The caller does not have update access to the Book.

404Not Found. A UUID in the path is malformed, or no insight with that UUID exists in the group named by insight_source. A UUID from the other group, a UUID on a different Book, and an AUS UUID in an organization without AUS ingestion all return 404.

500Internal Server Error. An unexpected error occurred, and the operation did not complete.