{"version":1,"pages":[{"id":"EeZXhpjMZJmKLHc0oqkF","title":"Envelope","pathname":"/","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"}]},{"id":"8vifp0KBG9zrYvJ53tNw","title":"Envelope Structure","pathname":"/api-documentation/envelope/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":"API Documentation"},{"label":"Envelope"}]},{"id":"VWA4y99DxtRM3um4lA4o","title":"Envelope Forms","pathname":"/api-documentation/envelope/envelope-forms","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of envelope forms, including how they work and what you can configure via the API.","breadcrumbs":[{"label":"API Documentation"},{"label":"Envelope"}]},{"id":"uoVfLHB9gRJmPBxKMDuY","title":"Send Envelope","pathname":"/api-documentation/envelope/send-envelope","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/send endpoint, including the request body format, example payloads, and the response UUID.","breadcrumbs":[{"label":"API Documentation"},{"label":"Envelope"}]},{"id":"TyWZjW2gfTCMEUFyIg6Y","title":"Envelope MetaData","pathname":"/api-documentation/envelope/envelope-metadata","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of envelope metadata, including how to add, update, and delete metadata for envelopes and envelope forms.","breadcrumbs":[{"label":"API Documentation"},{"label":"Envelope"}]},{"id":"6X5BgDaahPE0j6fnxYh4","title":"Fill Envelope","pathname":"/api-documentation/envelope/fill-envelope","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to fill an existing envelope via the API, including recipient role rules, the request body format, and an example payload.","breadcrumbs":[{"label":"API Documentation"},{"label":"Envelope"}]},{"id":"cTRx0jb7UEQgvgbeBz7M","title":"Billing Events for Envelope Sending","pathname":"/api-documentation/envelope/billing-events-for-envelope-sending","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how DocStudio identifies the source of an envelope send action and writes billing events for different sending methods.","breadcrumbs":[{"label":"API Documentation"},{"label":"Envelope"}]},{"id":"tdWvHtjDBVNaoWPaXlJz","title":"Widgets","pathname":"/api-documentation/widgets","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"}]},{"id":"0YwYaDXF6pwVsCMm0U31","title":"Simple File Send Widget","pathname":"/api-documentation/widgets/simple-file-send-widget","siteSpaceId":"sitesp_Dnnv3","description":"This document contains instructions for using and embedding the Simple File Send Widget, including the file submission flow, integration steps, and size limits.","breadcrumbs":[{"label":"API Documentation"},{"label":"Widgets"}]},{"id":"oZMw06BN27aCgM7D0GTF","title":"API Methods","pathname":"/api-documentation/api-methods","siteSpaceId":"sitesp_Dnnv3","description":"","breadcrumbs":[{"label":"API Documentation"}]},{"id":"tdVxWQDQ4uugzEN9ZIKA","title":"Platform Endpoints","pathname":"/api-documentation/api-methods/platform-endpoints","siteSpaceId":"sitesp_Dnnv3","description":"This document contains a categorized list of platform API endpoints, including the base URL and common authorization, template, envelope, and account routes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"vrxW0BqhcCUgU7surZd8","title":"Authorization","pathname":"/api-documentation/api-methods/authorization","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/login authorization endpoint, including the request format, response example, and status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"2zIRCHJBmubs0Xs05d0x","title":"Create Template","pathname":"/api-documentation/api-methods/create-template","siteSpaceId":"sitesp_Dnnv3","description":"This document explains how to create a template via the /api/v1/template endpoint, including the request body, template XML, and response fields.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"6gLzTG6l7yk6mg1Ko5I8","title":"Upload Attachment/External Documents Method","pathname":"/api-documentation/api-methods/upload-attachment-external-documents-method","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/attachment endpoint, including how to upload a binary file and the response fields.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"ZzcNjZRZWdu7SvdMy54G","title":"Download Envelope Documents Archive","pathname":"/api-documentation/api-methods/download-envelope-documents-archive","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/envelope/{envelopeUuid}/zip endpoint, including query parameters and how ZIP contents vary by document state.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"NUvqsJd3hKNQZlRayJI4","title":"Audit Trail Record","pathname":"/api-documentation/api-methods/audit-trail-record","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"zxvak60PPH5QRmoqMEV1","title":"Create Audit Trail Record","pathname":"/api-documentation/api-methods/audit-trail-record/create-audit-trail-record","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the PUT /api/v1/audittrail/envelope/{uuid} endpoint, including the request method, path parameter, and response status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Audit Trail Record"}]},{"id":"4uVoJvznRhIPW9Sacr12","title":"Get Envelope Audit Trail","pathname":"/api-documentation/api-methods/audit-trail-record/get-envelope-audit-trail","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the GET /api/v1/audittrail/envelope/{uuid} endpoint, including the request method, path parameter, and response status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Audit Trail Record"}]},{"id":"DrGMZEc8pp4hokLmqF2R","title":"Export Envelope Audit Trail PDF File","pathname":"/api-documentation/api-methods/audit-trail-record/export-envelope-audit-trail-pdf-file","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the GET /api/v1/audittrail/pdf/{uuid} endpoint, including the request method, path parameter, and response status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Audit Trail Record"}]},{"id":"8KNfFfjfeL7VpwKw4IJ5","title":"Search mailbox","pathname":"/api-documentation/api-methods/search-mailbox","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the GET /api/v1/mailbox/search endpoint, including headers, the q query parameter, request and response examples, and status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"rz9b80ybyy0we29R4HjN","title":"Check Envelope Status","pathname":"/api-documentation/api-methods/check-envelope-status","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/mailbox/{uuid} endpoint, including filter parameters, request examples, response examples, and status codes.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"uAj49DZ1HuD6DjIxTi7X","title":"Account Corporate Users","pathname":"/api-documentation/api-methods/account-corporate-users","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the corporate users API endpoints for an account, including downloading an example XLSX file and mass creating users.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"KDnKBsXLwF8edIr6DoCF","title":"Account Domains","pathname":"/api-documentation/api-methods/account-domains","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"}]},{"id":"IrALu0Gg5DMYtfnUnFTB","title":"Add Account Domain","pathname":"/api-documentation/api-methods/account-domains/add-account-domain","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for adding a domain to an account via the /api/v1/account/{accountUuid}/domain endpoint, including requirements and request/response examples.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"efCFHXRluY7PNGiYypAa","title":"Verify Account Domain","pathname":"/api-documentation/api-methods/account-domains/verify-account-domain","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/verify endpoint, including the request body and response example for domain verification.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"dbqDlIgTK6YVl0t0oNEj","title":"Confirm Account Domain Verification","pathname":"/api-documentation/api-methods/account-domains/confirm-account-domain-verification","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/confirm endpoint, including how to confirm domain verification and the response example.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"Gmao1xeQKr54OYvHowOv","title":"Activate/Deactivate Account Domain","pathname":"/api-documentation/api-methods/account-domains/activate-deactivate-account-domain","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for activating and deactivating an account domain via the /activate and /deactivate endpoints, including response examples and domain statuses.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"goLIDJcwtYLoxNT07xVi","title":"Check Account Domain","pathname":"/api-documentation/api-methods/account-domains/check-account-domain","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/check endpoint, including check limits and a response example.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"R1LEFLink77Yqk4mUeCy","title":"Delete Account Domain","pathname":"/api-documentation/api-methods/account-domains/delete-account-domain","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for deleting an account domain via the DELETE /api/v1/account/{accountUuid}/domain/{domainUuid} endpoint.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"GDAIU2vBFPDpm15S5hog","title":"Search Account Domains","pathname":"/api-documentation/api-methods/account-domains/search-account-domains","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the GET /api/v1/account/{accountUuid}/domain endpoint, including pagination, search filters, and a response example.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"SxYYERNE6414cfVjgZQg","title":"Download Example File","pathname":"/api-documentation/api-methods/account-domains/download-example-file","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the GET /api/v1/account/{accountUuid}/users/example endpoint, including the request URL, headers, and returned XLSX example file.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"5VMG1Zdq3mJXM57zCedG","title":"Mass create users","pathname":"/api-documentation/api-methods/account-domains/mass-create-users","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details for the POST /api/v1/account/{accountUuid}/users endpoint, including the required headers, XLSX upload format, and target account parameter.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"X6yKhyt3lUanbMx5QR3C","title":"Domain Statuses & Verify Methods","pathname":"/api-documentation/api-methods/account-domains/domain-statuses-and-verify-methods","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of domain statuses and supported verification methods for account domains.","breadcrumbs":[{"label":"API Documentation"},{"label":"API Methods"},{"label":"Account Domains"}]},{"id":"mwqhFg8B2SQgK35MJzEI","title":"Template API","pathname":"/api-documentation/template-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains links to the Template API reference pages, including template structure, static elements, dynamic fields, and PDF fields.","breadcrumbs":[{"label":"API Documentation"}]},{"id":"3idlPdRT9hiFKEeVZxmg","title":"Template Structure API","pathname":"/api-documentation/template-api/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":"API Documentation"},{"label":"Template API"}]},{"id":"yUzNyS4e7oQ72bwmQ07Y","title":"Template Static Elements API","pathname":"/api-documentation/template-api/template-static-elements-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details on static template elements, focusing on image tags, required hash attributes, and the image upload/download API endpoints.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"}]},{"id":"wVbsBPDRRCULvm2TEDbj","title":"Template Dynamic Fields API","pathname":"/api-documentation/template-api/template-dynamic-fields-api","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"}]},{"id":"kZ4lTATBOqqRVeIjxTS1","title":"Text Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/text-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Text field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"wgZHVaLewp8xHU5d3q67","title":"Number Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/number-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Number field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"Pwmyn0rPt9b3WQpctYd1","title":"Currency Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/currency-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Currency field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"WX1cssbeLpZmc04ocw2S","title":"Date Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/date-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Date field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"ynSxRElD3CZHWwWY7hSU","title":"Dropdown Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/dropdown-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Dropdown field API format, attributes, and option value rules.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"cZBiQpXwUMhk5BCoohmO","title":"Choice Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/choice-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Choice (radio button) field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"rFzBobWwFIc2fpt7GDxT","title":"Checkbox Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/checkbox-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Checkbox field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"2BRhvlBBEouSS5IC4xLe","title":"File Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/file-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the File field API format, supported attributes, and attachment type rules.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"a9sUiHbhtniPrHWY8Xm2","title":"Dictionary Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/dictionary-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Dictionary field API format, attributes, and filterQuery examples.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"MR73KbTk3vQqGs6IBbAu","title":"Lookup Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/lookup-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Lookup field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"6CRepOSS4NOwaQbp2jOK","title":"Dynamic Table API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/dynamic-table-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Dynamic table field API format, attributes, and an example.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"XkEkbD7iC5UlXf9DiqVi","title":"Duplicate Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/duplicate-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Duplicate field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"AM9xZV2VFH3QNWW4Hpuc","title":"Formula Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/formula-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Formula field API format, supported attributes, operations, and examples.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"U5PoFKgwUjiytGeVLJrM","title":"Autonumber Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/autonumber-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Autonumber field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"0va17iasPWjKfwCPfIsr","title":"Signature Field API","pathname":"/api-documentation/template-api/template-dynamic-fields-api/signature-field-api","siteSpaceId":"sitesp_Dnnv3","description":"This document contains the Signature field API format and a list of supported attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"},{"label":"Template Dynamic Fields API"}]},{"id":"dctwm230Mv5JbdVOZsIf","title":"PDF Fields in Template","pathname":"/api-documentation/template-api/pdf-fields-in-template","siteSpaceId":"sitesp_Dnnv3","description":"This document contains details on using dynamic fields with uploaded PDF templates, including required PDF field attributes.","breadcrumbs":[{"label":"API Documentation"},{"label":"Template API"}]},{"id":"Sd5Dj0Z8R4Ni8KxQIntA","title":"Common API Error Codes","pathname":"/api-documentation/common-api-error-codes","siteSpaceId":"sitesp_Dnnv3","description":"This document contains common API error codes and what each code typically means in DocStudio.","breadcrumbs":[{"label":"API Documentation"}]},{"id":"07BpM9MppycZqfMVTvmR","title":"Dictionaries API","pathname":"/api-documentation/dictionaries-api","siteSpaceId":"sitesp_Dnnv3","breadcrumbs":[{"label":"API Documentation"}]},{"id":"6pSvMbsdmGBcSpzWKlEB","title":"How to Import Dictionary CSV","pathname":"/api-documentation/dictionaries-api/how-to-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":"API Documentation"},{"label":"Dictionaries API"}]},{"id":"VDRe5RW3lQWIlqDfW9xv","title":"Server Configuration Information","pathname":"/server-configuration/server-configuration-information","siteSpaceId":"sitesp_Dnnv3","description":"This document contains an overview of server configuration properties, including global, user, locale, password policy, and session policy settings.","breadcrumbs":[{"label":"Server Configuration"}]},{"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"}]},{"id":"nRMaUe69WZluNPaxYh1W","title":"Error Codes Knowledge Base","pathname":"/error-codes/error-codes-knowledge-base","siteSpaceId":"sitesp_Dnnv3","description":"This document identifies types of errors. Each error code has common error type and also this codes are different depends on issue.","breadcrumbs":[{"label":"Error Codes"}]}]}