Documents
Document Solution Update
Updates an existing document solution.
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
documentSolutionGuid*string
GUID of the document solution to update.
Format
uuidRequest Body
application/json
The DocumentSolutionModel payload to update. Server-managed fields (ids, timestamps, links, isDeleted) are ignored.
TypeScript Definitions
Use the request body type in TypeScript.
A stored document solution: the pairing of templates, data sources and output configurations that document generation runs against. Everything marked read-only here is server-assigned and ignored if sent.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/documents/solution/d290f1ee-6c54-4b01-90e6-d701748f0851/update" \ -H "Content-Type: application/json" \ -d '{ "name": "Quarterly Invoice Package", "description": "Bundles the invoice template with Q3 account data.", "dataGuid": "3f2504e0-4f89-41d3-9a0c-0305e82c3301" }'{ "result": { "data": { "documentSolution": { "documentSolutionGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851", "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "dataGuid": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "Quarterly Invoice Package", "description": "Bundles the invoice template with Q3 account data.", "createdDate": "2026-07-14T09:30:00.000Z", "lastModifiedDate": "2026-07-14T09:30:00.000Z", "isDeleted": false } }, "statusCode": 200, "message": "OK" }, "origin": "PUT https://api.doctavian.com/v1/documents/solution/{documentSolutionGuid}/update", "dateTime": "2026-07-14T09:30:00.000Z", "operationId": "a77619f90a443a9e9c8cfbe2b89ba6d2", "userId": "4716bbfc-b2c2-4143-8359-aefaac205d94"}{ "userId": "8117dec4-90f7-4967-8591-92e5bd1641a4", "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/solution/{documentSolutionGuid}/update", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "733572e81edf9e093bd825fca7add842"}{ "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/solution/{documentSolutionGuid}/update", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "0b24c2386bc4a08214b771703f629971", "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/solution/{documentSolutionGuid}/update", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "537ccf7f938547387f5351e171a6cbfe", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "userId": "55d1d9b5-e5e7-4255-9bdd-f1f1a6b4adea", "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/solution/{documentSolutionGuid}/update", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "6d93e62679d0f3ac8930e936f824b1ff"}