PUT

/Document

When to Use

Document Metadata Updates - Use this endpoint to modify existing document records. Essential for:

  • Metadata Corrections: Updating document names, descriptions, or codes after creation
  • Portal Visibility Management: Changing showInDocumentsInPortal flag based on business rules
  • Entity Re-association: Moving documents between BizEntities, Organisations, or Products
  • Security Settings: Modifying password protection or public access permissions

Prerequisites

  • Authentication: Valid Bearer token with document update permissions
  • Document Existence: Document with specified documentID must exist
  • Entity Validation: Referenced BizEntity, Organisation, or Product IDs must exist if provided

Considerations

  • Full Replacement: PUT operation replaces entire document record - provide all fields
  • File Content Unchanged: Updates metadata only - associated files remain intact
  • Identifier Required: documentID must match an existing document
  • Portal Impact: Changes to visibility flags take effect immediately in investor portals
  • Audit Trail: Updates may be logged for compliance tracking
  • Product Validation Logic: ProductID takes precedence if > 0, otherwise ExternalProductId is used. At least one must be provided for product security validation
  • ExternalDocumentId Uniqueness: Uniqueness is scoped per ProductID. You can reuse the same ExternalDocumentId across different products without conflicts
  • BizEntity Permissions: Associating documents with a BizEntity triggers automatic permission validation. Operation fails with 400 Bad Request if user lacks access rights
  • Entity Association Flexibility: Documents can be associated at Product level (accessible to all), BizEntity level (investor-specific), or Organisation level (corporate-specific) based on access control requirements

Description

Updates an existing document metadata record in the 7G system. Performs a complete replacement of all document properties, associations, and visibility settings while preserving any uploaded file content. The documentID must reference an existing document.

Required Headers - See Authentication

HeaderValueDescription
Content-Typeapplication/jsonRequest content type
Authorization{accessToken}Bearer token for API access
Version2.0API 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. Used for integration and synchronization. Uniqueness is scoped to ProductID - the same ExternalDocumentId can exist across different products without conflicts.
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. Use for investor-specific documents. If provided, triggers permission validation to ensure user has access rights to this BizEntity.
externalBizEntityId >
string
Your external business entity identifier. Used for entity association when BizEntityID is not provided or equals 0. Triggers same permission validation as BizEntityID.
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
integer
The unique identifier of the document to update. Must reference an existing document.
externalDocumentId
string
Optional
Your external system identifier for the document. Used for integration and synchronization. Uniqueness is scoped to ProductID - the same ExternalDocumentId can exist across different products without conflicts.
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. Use for investor-specific documents. If provided, triggers permission validation to ensure user has access rights to this BizEntity.
externalBizEntityId
string
Your external business entity identifier. Used for entity association when BizEntityID is not provided or equals 0. Triggers same permission validation as BizEntityID.
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.

Example Requests

json
{
  "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
}

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
  }
}
GET Retrieve document metadata POST Create document record DELETE Delete document record PUT /Document/File - Update file content