{"version":1,"pages":[{"id":"JVJsvh4SXmcwIzooB1El","title":"API Overview","pathname":"/","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of DocStudio API capabilities and common integration workflows.","breadcrumbs":[{"label":"Introduction"}]},{"id":"p5NieAfeaSFOzDUXUDVX","title":"Core concepts","pathname":"/introduction/core-concepts","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the main DocStudio API concepts and their relationships.","breadcrumbs":[{"label":"Introduction"}]},{"id":"n1a12iww7ouhcWtbw4pt","title":"Authentication and Application tokens","pathname":"/introduction/authentication-and-application-tokens","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to authenticate DocStudio API requests with application and temporary authorization tokens.","breadcrumbs":[{"label":"Introduction"}]},{"id":"s7qNxG3y0HsfwXfrK8Rw","title":"API token security","pathname":"/introduction/api-token-security","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to store, use, and replace DocStudio API tokens securely.","breadcrumbs":[{"label":"Introduction"}]},{"id":"EA3AhErwuMbTjp2Yen5m","title":"Send your first envelope","pathname":"/introduction/send-your-first-envelope","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to send, track, and download your first envelope with DocStudio API.","breadcrumbs":[{"label":"Introduction"}]},{"id":"6PZWAcHPsQ67ckKMzfei","title":"Automation Overview","pathname":"/automation-overview","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of DocStudio Automations and available automation bricks."},{"id":"oo6UCkgCk22XtVHTay39","title":"Create an Automation","pathname":"/create-an-automation","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to create and verify a DocStudio Automation."},{"id":"aH3Oo3OvJV6OKvRVhfW9","title":"Automation Examples","pathname":"/automation-examples","siteSpaceId":"sitesp_Dnnv3","description":"Examples of DocStudio Automations that notify chat services and approve vacation requests."},{"id":"WrrBs9zadY6j50PCTcyK","title":"Credentials","pathname":"/credentials","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to manage credentials for DocStudio Automations."},{"id":"9r4kQBpYMmAZsAETcY6p","title":"Automation Executions and Logs","pathname":"/automation-executions-and-logs","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to inspect automation executions, diagnose failed operations, and reprocess them."},{"id":"I3cGHzKSNM7mGtywfJMj","title":"Automation types","pathname":"/automation-types","siteSpaceId":"sitesp_Dnnv3"},{"id":"cQtvhavnOur2mAt2DYJq","title":"Envelope","pathname":"/automation-types/envelope","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"Automation types"}]},{"id":"B4W4k1iaqw6aa1bR2TYj","title":"Data Transformation and Processing","pathname":"/automation-types/data-transformation-and-processing","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"Automation types"}]},{"id":"xgXMqN1lUOfTHMPp03Fz","title":"Validation and Logic","pathname":"/automation-types/validation-and-logic","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"Automation types"}]},{"id":"iYONOmZSKpX5EJHq3bdW","title":"Integration","pathname":"/automation-types/integration","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"Automation types"}]},{"id":"8WRhKoydIFcnkDgjCQCo","title":"AI","pathname":"/automation-types/ai","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"Automation types"}]},{"id":"gGRWJWckari9SZKLC5u3","title":"Templates and reusable IDs","pathname":"/guides/templates-and-reusable-ids","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to find, reuse, and validate template and API identifiers in DocStudio integrations.","breadcrumbs":[{"label":"Guides"}]},{"id":"3idlPdRT9hiFKEeVZxmg","title":"Template Structure API","pathname":"/guides/template-structure-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the template object structure, including the template information block and the XML stored in the data field.","breadcrumbs":[{"label":"Guides"}]},{"id":"T8d74PDtbh7VQXv6AMpu","title":"XML payloads","pathname":"/guides/xml-payloads","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to build, escape, and validate XML payloads for DocStudio API requests.","breadcrumbs":[{"label":"Guides"}]},{"id":"8vifp0KBG9zrYvJ53tNw","title":"Envelope Structure","pathname":"/guides/envelope-structure","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the envelope XML structure, including the fields you can include in the request body.","breadcrumbs":[{"label":"Guides"}]},{"id":"owUmaPIdyk4lLQixHKHI","title":"Envelope fields","pathname":"/guides/envelope-fields","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to configure template fields and send valid field values in DocStudio envelopes.","breadcrumbs":[{"label":"Guides"}]},{"id":"xfp4Wooo0wjykXpQKMgg","title":"Files and external documents","pathname":"/guides/files-and-external-documents","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to upload files and use them in DocStudio envelopes.","breadcrumbs":[{"label":"Guides"}]},{"id":"N1y2mtLY1qJWNBSmamYs","title":"Envelope metadata","pathname":"/guides/envelope-metadata","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to add, manage, display, and use envelope metadata.","breadcrumbs":[{"label":"Guides"}]},{"id":"lYuA58rGtnfSZklEdymA","title":"Envelope callbacks","pathname":"/guides/envelope-callbacks","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the endpoint reference for creating and managing envelope callbacks.","breadcrumbs":[{"label":"Guides"}]},{"id":"CHFYbdzShWk4Gos0Ap5T","title":"List responses","pathname":"/guides/list-responses","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to paginate, filter, sort, and search list responses in DocStudio API.","breadcrumbs":[{"label":"Guides"}]},{"id":"9tXql3Jbyl5LGxYAr0Xg","title":"API versioning","pathname":"/guides/api-versioning","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to use DocStudio API versions safely and maintain compatible integrations.","breadcrumbs":[{"label":"Guides"}]},{"id":"6pSvMbsdmGBcSpzWKlEB","title":"Import Dictionary CSV","pathname":"/guides/import-dictionary-csv","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to import a dictionary CSV file, including the upload step and the import confirmation request.","breadcrumbs":[{"label":"Guides"}]},{"id":"0YwYaDXF6pwVsCMm0U31","title":"Simple File Send widget","pathname":"/guides/simple-file-send-widget","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to use and embed the Simple File Send Widget.","breadcrumbs":[{"label":"Guides"}]},{"id":"c20lHyayQGDfXDVjEqyQ","title":"Send Envelope from Template","pathname":"/examples/send-envelope-from-template","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to create, send, track, and download an envelope from a DocStudio template.","breadcrumbs":[{"label":"Examples"}]},{"id":"rgqMdFiTTtOY4ygzXfkV","title":"Send Envelope with Prefilled Fields","pathname":"/examples/send-envelope-with-prefilled-fields","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to send a template envelope with prefilled fields.","breadcrumbs":[{"label":"Examples"}]},{"id":"iGgoWpjeS8xOiAGhyo0I","title":"Send Envelope with Metadata","pathname":"/examples/send-envelope-with-metadata","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to store and use envelope metadata through the API.","breadcrumbs":[{"label":"Examples"}]},{"id":"hAOc7QtYhaNaiSxNyraE","title":"Authorization","pathname":"/api-reference/authorization","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/login endpoint, including the request body, response token, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"aX81FlEJUgHuy0SSqEL5","title":"Send Envelope","pathname":"/api-reference/send-envelope","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/send endpoint, including headers, request parameters, response fields, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"KoxtVRfe7BjQ6b4cJdlq","title":"Check Envelope Status","pathname":"/api-reference/check-envelope-status","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/{envelopeUuid} endpoint, including headers, parameters, response fields, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"ZauuhPPqE8Th56bPJWE7","title":"Download Envelope Archive","pathname":"/api-reference/download-envelope-archive","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to download a completed envelope archive through DocStudio API.","breadcrumbs":[{"label":"API reference"}]},{"id":"veEuE39TQz6xtgYiiHKc","title":"Upload Attachments","pathname":"/api-reference/upload-attachments","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/attachment endpoint, including headers, request body, response fields, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"8eIkwYUrZBlpF60eVQub","title":"Fill Envelope","pathname":"/api-reference/fill-envelope","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/fill endpoint, including headers, request body, response, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"mh06ZK3fbZQhR3nLUwmx","title":"Create Template","pathname":"/api-reference/create-template","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/template endpoint, including headers, request body, response fields, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"8E1PqCBnnKgrIMhLcTWS","title":"Search Mailboxes and Contacts","pathname":"/api-reference/search-mailboxes-and-contacts","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/mailbox/search endpoint, including headers, query parameters, response fields, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"AIfL3NObGuskZSf17jjJ","title":"Account Domains","pathname":"/api-reference/account-domains","siteSpaceId":"sitesp_Dnnv3","description":"This document contains account domain endpoints, including parameters, requests, responses, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"6lvr91DvtOhNVqRhrlkC","title":"Dictionaries","pathname":"/api-reference/dictionaries","siteSpaceId":"sitesp_Dnnv3","description":"This document contains dictionary endpoints, including parameters, request bodies, responses, and status codes.","breadcrumbs":[{"label":"API reference"}]},{"id":"Y5kyoJFZQ59oZDtb2vpV","title":"Application token object","pathname":"/object-reference/application-token-object","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the application token object returned by token endpoints.","breadcrumbs":[{"label":"Object reference"}]},{"id":"n809l964Ts0JWgPFUNvO","title":"List response object","pathname":"/object-reference/list-response-object","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the pagination object used in list responses.","breadcrumbs":[{"label":"Object reference"}]},{"id":"O1CB2uqwS2jftxrP4ArP","title":"UUID list object","pathname":"/object-reference/uuid-list-object","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the UUID list response object.","breadcrumbs":[{"label":"Object reference"}]},{"id":"blf1BhLYoQeUpbKU0BSx","title":"UUID response object","pathname":"/object-reference/uuid-response-object","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the UUID response object returned by API operations.","breadcrumbs":[{"label":"Object reference"}]},{"id":"noLjN9oSEY4Yer1pSEBC","title":"Error handling and API error codes","pathname":"/error-codes/error-handling-and-api-error-codes","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to interpret API errors and resolve common request failures.","breadcrumbs":[{"label":"Error Codes"}]},{"id":"rrrrwnowvCrcHnNZF3VV","title":"Java & PHP Software Development Kits","pathname":"/java-and-php/java-and-php-software-development-kits","siteSpaceId":"sitesp_Dnnv3","description":"This document contains links to the Java and PHP SDKs, including quick start resources and the published Composer package for PHP.","breadcrumbs":[{"label":"Java & PHP"}]}]}