Document Solution Configuration Create
Creates a new document solution configuration.
JWT token to authenticate the request.
In: header
API key, sent as a request header.
In: header
Request Body
application/json
The DocumentSolutionConfigurationModel payload to create. Server-managed fields (ids, timestamps, links, isDeleted) are ignored.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/documents/configuration/create" \ -H "Content-Type: application/json" \ -d '{ "documentSolutionGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "Invoice - PDF via Email", "description": "Renders invoices as PDF and e-mails them to the customer.", "title": "Invoice", "fileFormat": "pdf", "processingType": "STANDARD", "deliveryMethod": "Email", "path": "output/invoices/", "pdfConformanceLevel": "PdfA2B", "pdfVersion": "2026-01-07", "language": "en", "locale": "en-US", "timeZone": "America/New_York", "embeddedData": "{\\"companyName\\":\\"Contoso Ltd\\"}", "viewAnonymous": false, "editAnonymous": false, "viewOrganization": true, "editOrganization": false, "viewUser": true, "editUser": false, "viewUserEmailList": "alice@example.com,bob@example.com", "editUserEmailList": "carol@example.com" }'{ "result": { "data": { "documentSolutionConfiguration": { "documentSolutionConfigurationGuid": "a3bb189e-8bf9-3888-9912-ace4e6543002", "documentSolutionGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851", "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "name": "Invoice - PDF via Email", "description": "Renders invoices as PDF and e-mails them to the customer.", "title": "Invoice", "fileFormat": "pdf", "processingType": "STANDARD", "deliveryMethod": "Email", "path": "output/invoices/", "pdfConformanceLevel": "PdfA2B", "pdfVersion": "2026-01-07", "language": "en", "locale": "en-US", "timeZone": "America/New_York", "embeddedData": "{\"companyName\":\"Contoso Ltd\"}", "viewAnonymous": false, "editAnonymous": false, "viewOrganization": true, "editOrganization": false, "viewUser": true, "editUser": false, "viewUserEmailList": "alice@example.com,bob@example.com", "editUserEmailList": "carol@example.com", "createdDate": "2026-07-14T09:30:00.000Z", "lastModifiedDate": "2026-07-14T09:30:00.000Z", "isDeleted": false } }, "statusCode": 200, "message": "OK" }, "origin": "POST https://api.doctavian.com/v1/documents/configuration/create", "dateTime": "2026-07-14T09:30:00.000Z", "operationId": "aa6dd581a7275669d74c5ad3bac13f43", "userId": "8ea9f9f4-546f-4520-9df8-e6cead6ee23e"}{ "userId": "0714c002-c66c-4788-bf53-e9b31b7d1f30", "error": { "statusCode": 400, "message": "Name is required.", "innerErrors": [ { "code": "DATA_NAME_REQUIRED", "message": "Name is required.", "userMessage": "Name is required." } ] }, "origin": "POST https://api.doctavian.com/v1/documents/configuration/create", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "376bd67d617ffe86e16f45a11d684a6f"}{ "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": "POST https://api.doctavian.com/v1/documents/configuration/create", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "9fb7041c0882d2273ef09cf1357fc0cf", "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": "POST https://api.doctavian.com/v1/documents/configuration/create", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "3af058f6225e863fc3bbb4398cf41587", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "userId": "69e903bd-114d-4d73-a091-b0c05d30990b", "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": "POST https://api.doctavian.com/v1/documents/configuration/create", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "181ef627a71423e57f00e55f60d6298f"}