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
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": "https://app.example.com", "dateTime": "2026-07-14T09:30:00.0000000+00:00", "operationId": "0HN7GK9M4T2R5"}{ "code": "DATA_NAME_REQUIRED", "message": "Name is required."}Empty
Empty
{ "code": "GET_DATA_SOURCE_ERROR", "message": "An unexpected error occurred.", "eventId": "a1b2c3d4"}