Documents

Mark Document as Read

Mark a document as read, which is what takes it out of the inbox, or send read: false to put it back.

POST
/api/v1/documents/{documentId}/mark-as-read

Mark a document as read, which is what takes it out of the inbox, or send read: false to put it back. Calling it again with the same value is harmless. Reading a document through the other endpoints does not mark it: this endpoint is the only thing that does, so an integration decides for itself when a document is done.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

documentId*string

The ID of the document to mark as read or unread

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/documents/string/mark-as-read" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true}

Inbox GET

List the incoming documents that have not been marked as read.

Download Document Package GET

Download everything stored for one document as a zip: document.json with its metadata and parsed contents, document.xml with the document as it went...