TemplateLocks Resource

The TemplateLocks resource provides methods that allow you to manage locks on an template.

You can lock the template, and set the time until the lock expires, to prevent users from accessing and changing the template.

Users must have envelope locking capability enabled to use these functions.

Methods supported

Method	Description
create	POST `/restapi/v2/accounts/{accountId}/templates/{templateId}/lock` Lock a template.
delete	DEL `/restapi/v2/accounts/{accountId}/templates/{templateId}/lock` Deletes a template lock.
get	GET `/restapi/v2/accounts/{accountId}/templates/{templateId}/lock` Gets template lock information.
update	PUT `/restapi/v2/accounts/{accountId}/templates/{templateId}/lock` Updates a template lock.

Property	Type	Description
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`lockDurationInSeconds`	string	Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.
`lockedByApp`	string	Specifies the friendly name of the application that is locking the envelope.
`lockedByUser`	userInfo	A complex type containing information about the user that has the Envelope or Template locked.
`lockedUntilDateTime`	string	The datetime until the envelope lock expires.
`lockToken`	string	A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
`lockType`	string	The type of envelope lock. Currently “edit” is the only supported type.
`useScratchPad`	string	Reserved for future use. Indicates whether a scratchpad is used for editing information.