UpdateDocument
Executes an update operation on the latest version of a specified document, modifying only editable fields, such as metadata or custom attributes, without affecting prior versions.
Stored Procedure Specific Information
The UpdateDocument stored procedure is DEPRECATED. Use the Documents table instead.
To determine the API field names for the Documents table, query the Description column in sys_tablecolumns. For example:
SELECT Description FROM [sys_tablecolumns] WHERE TableName = 'Documents'
The Description column lists the API field names used by the Documents table. Use these names when updating a document. For example:
EXEC UpdateDocument DocumentId = '123', name__v = 'new name', product__v = 'new product'
Input
| Name | Type | Required | Description |
| DocumentId | String | True | Required input. Specifies the unique identifier of the document to be updated. This value must match an existing document record in the system. |
Result Set Columns
| Name | Type | Description |
| ResponseStatus | String | Indicates the outcome of the update operation. Returns a status such as Success, Failure, or ValidationError based on the execution result. |
| Id | String | The unique identifier of the document after the update attempt. Matches the input DocumentId if the update is successful. |