Skip to main content
Solved

Template Get password param between v2.0 and 2.1 - incorrect docs?

  • February 20, 2025
  • 2 replies
  • 20 views

Forum|alt.badge.img+1

I’m working on updating our Java SDK usage from 2.17 to 6.0.0 and API from v2.0 to v2.1. Given some signature changes I’m comparing with the API references to make sure I’m making the correct changes.

 

We have a process to create templates, and we set a password to prevent accidental editing - in v2.0 it’s part of the envelope template definition (https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/create/#schema__envelopetemplate_envelopetemplatedefinition).

 

In v2.1 at some point I believe the fields in the template definition object were flattened to the envelopeTemplate object, including the `password` field (https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/#schema__envelopetemplate_password). However the documentation for that field (at that link) indicates that it’s the **user’s** password instead of the template password. I think that’s incorrect?

 

I will at some point probably test this but it would be helpful to have confirmation. There’s nothing indicative in the Java SDK changelog and the release notes for the API are hard to search.

Best answer by JohnSantos

@Georgia. 

You’re correct: in v2.1, the password property on the EnvelopeTemplate object is the same “template lock” (or “prevent accidental editing”) password as in v2.0, and not the user’s personal password. The documentation that describes it as the user’s password is a known inaccuracy in the docs.

View Original
Is this content helpful?

2 replies

JohnSantos
Valued Contributor
Forum|alt.badge.img+18
  • Valued Contributor
  • 959 replies
  • Answer
  • February 20, 2025

@Georgia. 

You’re correct: in v2.1, the password property on the EnvelopeTemplate object is the same “template lock” (or “prevent accidental editing”) password as in v2.0, and not the user’s personal password. The documentation that describes it as the user’s password is a known inaccuracy in the docs.


Forum|alt.badge.img+1
  • Author
  • Newcomer
  • 1 reply
  • February 20, 2025

Thanks for the quick reply!