Documents
Option Value Replace
Bulk-replaces the full set of option values for the entity named in the path. Every item in the array is validated with the same rules as create.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Path Parameters
entityType*string
Type of the owning entity, e.g. "DocumentSolutionConfiguration" or "DocumentTemplate".
entityId*string
GUID of the owning entity.
Format
uuidRequest Body
application/json
The complete new set of option values for the entity.
TypeScript Definitions
Use the request body type in TypeScript.
[index: integer]?
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/documents/option/DocumentSolutionConfiguration/a3bb189e-8bf9-3888-9912-ace4e6543002/replace" \ -H "Content-Type: application/json" \ -d '[ { "customKey": "watermark.text", "customGroup": "rendering", "value": "CONFIDENTIAL" }, { "optionDefinitionId": 42, "value": "true" } ]'{ "result": { "data": { "entityId": "a3bb189e-8bf9-3888-9912-ace4e6543002", "entityType": "DocumentSolutionConfiguration", "message": "Entity options replaced successfully." }, "statusCode": 200, "message": "OK" }, "origin": "PUT https://api.doctavian.com/v1/documents/option/{entityType}/{entityId}/replace", "dateTime": "2026-07-14T09:30:00.000Z", "operationId": "d1a0f7ad0711e8714e5bcc226716061a", "userId": "768bd53c-191f-4968-9ba1-e5f317511800"}{ "userId": "488b01de-e8d1-4c59-8662-f2964128bdff", "error": { "statusCode": 400, "message": "Name is required.", "innerErrors": [ { "code": "DATA_NAME_REQUIRED", "message": "Name is required.", "userMessage": "Name is required." } ] }, "origin": "PUT https://api.doctavian.com/v1/documents/option/{entityType}/{entityId}/replace", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "6aa27229106b501cb4755386f79273b6"}{ "error": { "statusCode": 401, "message": "The request could not be authenticated.", "innerErrors": [ { "code": "UNAUTHORIZED", "message": "The request could not be authenticated.", "userMessage": "Your session has expired or is invalid. Please sign in again." } ] }, "origin": "PUT https://api.doctavian.com/v1/documents/option/{entityType}/{entityId}/replace", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "cef4804e3e1338514a188b74b952cb47", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "error": { "statusCode": 404, "message": "The requested resource was not found.", "innerErrors": [ { "code": "NOT_FOUND_BY_ID", "message": "The requested resource was not found.", "userMessage": "We couldn't find that resource. Check the id and try again." } ] }, "origin": "PUT https://api.doctavian.com/v1/documents/option/{entityType}/{entityId}/replace", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "e731367243e19ac1a3cb568d3df31ed2", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "userId": "c480fb73-0a48-49c9-b642-8f9bb01c4261", "error": { "statusCode": 500, "message": "An unexpected error occurred.", "innerErrors": [ { "code": "GET_DATA_SOURCE_ERROR", "message": "An unexpected error occurred.", "userMessage": "An unexpected error occurred." } ] }, "origin": "PUT https://api.doctavian.com/v1/documents/option/{entityType}/{entityId}/replace", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "c34722a555933d3d060a2977d7602307"}