PUT
/Document
Usage Notes
When
- Update document names, descriptions, or codes after creation
- Change visibility flags or access permissions
- Move documents between entities
Requirements
- Document with specified documentID must exist
Notes
- PUT replaces entire document record (provide all fields)
- Updates metadata only (associated files remain intact)
- Changes to visibility flags take effect immediately in investor portals
Description
Updates an existing document metadata record. Performs complete replacement of properties, associations, and visibility settings while preserving uploaded file content.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
documentID |
integer | The unique identifier of the document to update. Must reference an existing document. | |
externalDocumentId |
string | Optional |
Your external system identifier for the document. Uniqueness scoped to ProductID - same ID allowed across different products. |
documentTypeID |
integer | The document type classification ID. Determines document handling and retention policies. | |
name |
string | Optional |
Human-readable document name for display in portals and lists. |
code |
string | Optional |
Short document code for internal reference and reporting. |
description |
string | Optional |
Detailed description of document content and purpose. |
password |
string | Optional |
Optional password protection for sensitive documents. |
ordinal |
integer | Optional |
Display order for document sorting in lists and portals. |
ProductID |
integer | The product identifier for document association and security validation. If ProductID > 0, it takes precedence over ExternalProductId. | |
externalProductId |
string | Your external product identifier. Used for product association when ProductID is not provided or equals 0. | |
BizEntityID |
integer | Associates the document with a specific business entity for investor-specific documents. Triggers permission validation. | |
externalBizEntityId |
string | Your external business entity identifier for entity association. Alternative to BizEntityID. Triggers permission validation. | |
OrganisationID |
integer | Associates the document with a specific organisation. Alternative to BizEntity association for corporate-level documents (e.g., trust deeds, constitutional documents, corporate actions). | |
externalOrganisationId |
string | Your external organisation identifier. Used for organisation association when OrganisationID is not provided or equals 0. Alternative to BizEntity for corporate-level document management. | |
showInDocumentsInPortal |
boolean | Controls whether the document appears in client-facing investor portals. | |
isPublic |
boolean | Determines if the document can be accessed without authentication. |
documentID
The unique identifier of the document to update. Must reference an existing document.
externalDocumentId
Your external system identifier for the document. Uniqueness scoped to ProductID - same ID allowed across different products.
documentTypeID
The document type classification ID. Determines document handling and retention policies.
name
Human-readable document name for display in portals and lists.
code
Short document code for internal reference and reporting.
description
Detailed description of document content and purpose.
password
Optional password protection for sensitive documents.
ordinal
Display order for document sorting in lists and portals.
ProductID
The product identifier for document association and security validation. If ProductID > 0, it takes precedence over ExternalProductId.
externalProductId
Your external product identifier. Used for product association when ProductID is not provided or equals 0.
BizEntityID
Associates the document with a specific business entity for investor-specific documents. Triggers permission validation.
externalBizEntityId
Your external business entity identifier for entity association. Alternative to BizEntityID. Triggers permission validation.
OrganisationID
Associates the document with a specific organisation. Alternative to BizEntity association for corporate-level documents (e.g., trust deeds, constitutional documents, corporate actions).
externalOrganisationId
Your external organisation identifier. Used for organisation association when OrganisationID is not provided or equals 0. Alternative to BizEntity for corporate-level document management.
showInDocumentsInPortal
Controls whether the document appears in client-facing investor portals.
isPublic
Determines if the document can be accessed without authentication.
Example Requests
bash
# Update document details
curl -X PUT 'https://api.7g.com.au/Document' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"documentID": 12347,
"externalDocumentId": "STMT_2024_Q1_001_REVISED",
"documentTypeID": 1,
"name": "Quarterly Investment Statement - Q1 2024 (Revised)",
"code": "Q1_STMT_2024_REV",
"description": "Revised quarterly investment statement",
"ordinal": 1,
"productID": 100,
"externalProductId": "GROWTH_FUND_AU",
"bizEntityID": 67890,
"externalBizEntityId": "CLIENT_ENT_001",
"showInDocumentsInPortal": true,
"isPublic": false
}'Response Examples
json
{
"result": true,
"message": "Document updated successfully",
"data": {
"documentID": 12347,
"externalDocumentId": "STMT_2024_Q1_001_REVISED",
"documentTypeID": 1,
"name": "Quarterly Investment Statement - Q1 2024 (Revised)",
"code": "Q1_STMT_2024_REV",
"description": "Revised quarterly investment statement showing corrected portfolio performance, transactions, and distribution details for Q1 2024",
"password": null,
"ordinal": 1,
"productID": 100,
"externalProductId": "GROWTH_FUND_AU",
"bizEntityID": 67890,
"externalBizEntityId": "CLIENT_ENT_001",
"organisationID": null,
"externalOrganisationId": null,
"showInDocumentsInPortal": true,
"isPublic": false
}
}