DESCRIPTION
This endpoint retrieves updates a document.
URL STRUCTURE
https://[hostname]/document/update/{documentId}
METHOD
POST
HEADERS
**Authorization:**
string Base64 [email]:[key]
ARGUMENTS
Name | Type | Description |
---|---|---|
documentId | int | Document ID |
PARAMETERS
Name | Type | Description |
---|---|---|
file | binary | Required. File to be uploaded. |
title | string | Title of the document. |
addendum | string | String to add to a pre-determined classification. |
primary-classification | int | Primary Classification ID. |
secondary-classification | int | Secondary Classification ID. |
notes | string | Notes field. |
status | enum | Status of document. |
attention-of | int | User ID of document for attention of. |
matter-id | string | Matter ID document belongs to. |
date | string | Date of the document. |
published-status | enum | Published status of the document. |
filing-status | enum | Filing status of the document. |
sender | string | Name of the sender. |
recipient | string | Name of the recipient. |
ENUMS
status
Value For API | Definition |
U | Unread |
O | Outstanding |
C | Complete |
published-status
Value For API | Definition |
1 | Recieved |
2 | Draft |
3 | Finalised |
4 | Draft (Sendable) |
filing-status
Value For API | Definition |
1 | To Be Filed |
2 | Filed |
RETURNS
Returns Document ID as string if successful.
“282”