Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.

Note: Users must have envelope locking capability enabled to use this function (the userSetting property canLockEnvelopes must be set to true for the user).

Request

HTTP request

POST /v2/accounts/{accountId}/templates/{templateId}/lock

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

templateIdstring

The ID of the template being accessed.

Request Body

lockRequest

Responses

CodeDescriptionReference
201

Successful response.

TemplateLocks
400

Error encountered.

errorDetails

SDK Method

Templates::createLock

Definitions

errorDetails
lockRequest
userInfo
TemplateLocks

Examples

Generic JSON Request/Response
Generic XML Request/Response