Document Template Update

Updates an existing document template.

Authorization

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

documentTemplateGuid*string

GUID of the document template to update.

Formatuuid

Request Body

application/json

The DocumentTemplateModel payload to update. Server-managed fields (ids, timestamps, links, isDeleted) are ignored.

TypeScript Definitions

Use the request body type in TypeScript.

A stored document template. Everything marked read-only here is server-assigned and ignored if sent on create or update.

name?string

Name identifying the template in listings and when attaching it to a document solution.

description?|

Free-text description of what this template produces.

title?|

Document title written into the generated output's document properties. This is not the template's own label in Doctavian — that is name.

urn?|

Identifier of the template file in the location named by loadMethod — a Storage key, a OneDrive file id or a Google Drive file id. Supply urn together with loadMethod, or supply url instead; the two are alternatives and only one applies to a given template.

A Storage key points at a file uploaded through documents-template-upload, and those files are removed once a document-generation request consumes them or after 24 hours, whichever comes first. A template record therefore does not hold a permanent copy of the file: upload it again and update the template's urn before each generation run. A OneDrive or GoogleDrive file is not affected — it stays on the drive and the template keeps working.

url?|

Absolute URL of the template file, as an alternative to urn plus loadMethod. Must be a well-formed absolute URI. Supply this or urn, not both.

viewAnonymousLink?|

Sharing link giving anyone with the link, without signing in view access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

editAnonymousLink?|

Sharing link giving anyone with the link, without signing in edit access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

viewUserLink?|

Sharing link giving named users view access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

editUserLink?|

Sharing link giving named users edit access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

viewOrganizationLink?|

Sharing link giving anyone signed into the same organization view access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

editOrganizationLink?|

Sharing link giving anyone signed into the same organization edit access to the template file. Only meaningful when the template is shared from a connected drive; supply it if you already hold the link, otherwise leave it out.

fileFormat?string

The template's file format, without a leading dot. Must be consistent with loadMethod: gdoc, gsheet and gslide are Google Workspace formats and are only usable when loadMethod is GoogleDrive; docx, xlsx and pptx are Microsoft formats and are only usable when loadMethod is Storage or OneDrive.

Value in

"docx"
"xlsx"
"pptx"
"gdoc"
"gsheet"
"gslide"

loadMethod?string

Where the template file identified by urn is stored.

Value in

"Storage"
"OneDrive"
"GoogleDrive"

Response Body

`application/json`

curl -X PUT "https://example.com/documents/template/7c9e6679-7425-40de-944b-e07fc1f90ae7/update" \  -H "Content-Type: application/json" \  -d '{    "name": "Standard Invoice",    "description": "Company standard invoice layout.",    "title": "Invoice",    "urn": "9f86d081-884c-4d30-8934-9c1e6cbcb9f5",    "url": "https://storage.example.com/templates/invoice-standard.docx",    "fileFormat": "docx",    "loadMethod": "Storage",    "path": "templates/invoice-standard.docx"  }'

{  "result": {    "data": {      "documentTemplate": {        "documentTemplateGuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",        "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",        "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d",        "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d",        "name": "Standard Invoice",        "description": "Company standard invoice layout.",        "title": "Invoice",        "urn": "9f86d081-884c-4d30-8934-9c1e6cbcb9f5",        "url": "https://storage.example.com/templates/invoice-standard.docx",        "viewAnonymousLink": "",        "editAnonymousLink": "",        "viewUserLink": "",        "editUserLink": "",        "viewOrganizationLink": "",        "editOrganizationLink": "",        "fileFormat": "docx",        "loadMethod": "Storage",        "path": "templates/invoice-standard.docx",        "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/template/{documentTemplateGuid}/update",  "dateTime": "2026-07-14T09:30:00.000Z",  "operationId": "971e051a82998181068eb88ac632119f",  "userId": "f47a5863-b953-4a51-9f84-c41a7414ef07"}

{  "userId": "e5bacd6d-39aa-46ff-bd76-24ad6da8b6a3",  "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/template/{documentTemplateGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "d02f7e30644ad44f5d492e787556faae"}

{  "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/template/{documentTemplateGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "53f97fd9ad3217a3c7e3d7b7d1d69b99",  "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/template/{documentTemplateGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "0fea796ed7baed277be338faba8df415",  "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}

{  "userId": "f0ef2024-8486-4a16-b86f-54a09684315b",  "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/template/{documentTemplateGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "84c29da640c4dfa67c2d841d5f5f8947"}

Document Template Update

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`