Own DocuSign? Customize your docs with AI search, analytics, and more.

GET

Gets template lock information.

https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock

Retrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the `lockToken`, for a locked template. The `X-DocuSign-Edit` header is included in the response. See TemplateLocks: create for a description of the `X-DocuSign-Edit` header. ### Related topics - Common API Tasks: Locking and unlocking envelopes

Access Token Required: API Key

Path Parameters

accountIdstringrequired

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

templateIdstringrequired

The ID of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets template lock information.

https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock

Retrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the `lockToken`, for a locked template. The `X-DocuSign-Edit` header is included in the response. See TemplateLocks: create for a description of the `X-DocuSign-Edit` header. ### Related topics - Common API Tasks: Locking and unlocking envelopes

Access Token Required: API Key

Path Parameters

accountIdstringrequired

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

templateIdstringrequired

The ID of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets template lock information.

https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock

Retrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the `lockToken`, for a locked template. The `X-DocuSign-Edit` header is included in the response. See TemplateLocks: create for a description of the `X-DocuSign-Edit` header. ### Related topics - Common API Tasks: Locking and unlocking envelopes

Access Token Required: API Key

Path Parameters

accountIdstringrequired

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

templateIdstringrequired

The ID of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets template lock information.

https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock

Retrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the `lockToken`, for a locked template. The `X-DocuSign-Edit` header is included in the response. See TemplateLocks: create for a description of the `X-DocuSign-Edit` header. ### Related topics - Common API Tasks: Locking and unlocking envelopes

Access Token Required: API Key

Path Parameters

accountIdstringrequired

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

templateIdstringrequired

The ID of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/templates/{templateId}/lock' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}