Skip to main content

I am trying to better understand what a template’s documentId is and when/why it will change

@ZachL -  A template's DocumentID is a unique identifier assigned to a specific document within a template. Each document added to a template receives its own DocumentID, which is used to reference that particular document when you're performing operations such as setting tabs or defining roles that are specific to the document.

Here are key points about when and why a DocumentID might change:

Creation of a New Document: When you create a new document and add it to a template, it will be assigned a new DocumentID. This ID is unique within the context of the template.


Template Duplication: If you duplicate a template, the documents within the new template will typically retain the same DocumentID as in the original template, unless specifically modified.


Editing Documents: If you remove a document from a template and then add it again, or if you add a new document to replace an existing one, the new document will receive a new DocumentID. Changes like renaming a document or modifying its content do not alter the DocumentID.


Consistency Across Envelopes: The DocumentID remains consistent for a given document within a template across different envelopes. This consistency is crucial for applications and integrations that programmatically interact with documents in a template.


Document Replacement in Envelopes: If a document within a sent envelope (but not yet completed) needs to be replaced, this operation can change the DocumentID. This is because technically, a new document is being inserted into the workflow.


The DocumentID is crucial for developers working with DocuSign APIs, as it helps in accurately targeting specific documents within a template for updates, especially when working with multiple documents in a single template.

 


Reply