Docusign

Docusign EnvelopeLocks API

The EnvelopeLocks resource provides methods that allow you to manage locks on an envelope. You can lock the envelope, and set the time until the lock expires, to prevent users or recipients from accessing and changing the envelope. Users must have envelope locking capability enabled to use these functions.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/lock Check whether an envelope is locked · Docusign Gets envelope lock information #
Ask an LLM
“Who has an envelope locked and when does the lock expire?”
“Can I recover a lost editing session from an envelope lock?”
Tell an agent
Show the lock on envelope {envelopeId}.
Get lock information for envelope {envelopeId} in account {accountId}.
PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/lock Extend or change an envelope lock · Docusign Updates an envelope lock #
Ask an LLM
“Can I extend how long my lock on an envelope lasts?”
“Which header is required to update an existing envelope lock?”
Tell an agent
Extend the lock on envelope {envelopeId} to {lockDurationInSeconds} seconds.
Update the lock on envelope {envelopeId} in account {accountId} to app {lockedByApp}.
POST /v2/accounts/{accountId}/envelopes/{envelopeId}/lock Lock an envelope for editing · Docusign Lock an envelope #
Ask an LLM
“Can I lock an envelope so nobody else changes it while I edit?”
“What user setting must be on before I can lock envelopes?”
Tell an agent
Lock envelope {envelopeId} for {lockDurationInSeconds} seconds.
Place an edit lock on envelope {envelopeId} in account {accountId}.
DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/lock Release an envelope lock · Docusign Deletes an envelope lock #
Ask an LLM
“Can I unlock an envelope once I'm done editing?”
“What do I have to send to remove a lock from an envelope?”
Tell an agent destructive · confirm first
Unlock envelope {envelopeId}.
Remove the lock from envelope {envelopeId} in account {accountId}.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock Gets envelope lock information #
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock Updates an envelope lock #
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock Locks an envelope #
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock Deletes an envelope lock #

Documentation

📖
Documentation
https://developers.docusign.com/docs/esign-rest-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/esign-rest-api/esign101/
📖
RateLimits
https://developers.docusign.com/docs/esign-rest-api/esign101/rules-and-limits/
📖
Documentation
https://developers.docusign.com/docs/admin-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/admin-api/admin101/
📖
RateLimits
https://developers.docusign.com/docs/admin-api/admin101/rules-and-limits/
📖
Documentation
https://developers.docusign.com/docs/click-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/click-api/click101/
📖
RateLimits
https://developers.docusign.com/docs/click-api/click101/rules-and-limits/
📖
Documentation
https://developers.docusign.com/docs/maestro-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/maestro-api/maestro101/
📖
Documentation
https://developers.docusign.com/docs/monitor-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/monitor-api/monitor101/
📖
Documentation
https://developers.docusign.com/docs/rooms-api/reference/
📖
GettingStarted
https://developers.docusign.com/docs/rooms-api/rooms101/
📖
RateLimits
https://developers.docusign.com/docs/rooms-api/rooms101/rules-and-limits/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/docusign/openapi/docusign-envelopelocks-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/docusign/asyncapi/docusign-connect-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/docusign/json-schema/docusign-envelope-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/docusign/json-ld/docusign-context.jsonld
🔗
Tutorials
https://developers.docusign.com/docs/esign-rest-api/how-to/
🔗
SDKs
https://developers.docusign.com/docs/esign-rest-api/sdks/
🔗
Tutorials
https://developers.docusign.com/docs/admin-api/how-to/
🔗
SDKs
https://developers.docusign.com/docs/admin-api/sdks/
🔗
Tutorials
https://developers.docusign.com/docs/click-api/how-to/
🔗
SDKs
https://developers.docusign.com/docs/click-api/sdks/
🔗
Tutorials
https://developers.docusign.com/docs/maestro-api/how-to/
🔗
Tutorials
https://developers.docusign.com/docs/monitor-api/how-to/
🔗
Tutorials
https://developers.docusign.com/docs/rooms-api/how-to/
🔗
SDKs
https://developers.docusign.com/docs/rooms-api/sdks/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/docusign:docusign-envelopelocks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

docusign-envelopelocks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Docusign Envelope Locks API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeLocks across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeLocks
  description: 'The EnvelopeLocks resource provides methods that allow you to manage locks on an envelope.


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


    Users must have envelope locking capability enabled to use these functions.'
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/lock:
    get:
      tags:
      - EnvelopeLocks
      summary: Docusign Gets envelope lock information
      description: 'Retrieves general information about the envelope lock.


        If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.'
      operationId: Lock_GetEnvelopeLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeLocks'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getLock
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeLocks
      summary: Docusign Updates an envelope lock
      description: Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
      operationId: Lock_PutEnvelopeLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lockRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/lockRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeLocks'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateLock
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: lockRequest
    post:
      tags:
      - EnvelopeLocks
      summary: Docusign Lock an envelope
      description: 'Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.


        ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).'
      operationId: Lock_PostEnvelopeLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lockRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/lockRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeLocks'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createLock
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: lockRequest
    delete:
      tags:
      - EnvelopeLocks
      summary: Docusign Deletes an envelope lock
      description: Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
      operationId: Lock_DeleteEnvelopeLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeLocks'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteLock
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock:
    parameters: []
    get:
      tags:
      - EnvelopeLocks
      summary: Gets envelope lock information
      description: 'Retrieves general information about an envelope lock.


        The user requesting the information must be the same user

        who locked the envelope.


        You can use this method to recover the lock information,

        including the `lockToken`,

        for a locked envelope.

        The `X-DocuSign-Edit` header is included in the response.


        See EnvelopeLocks: create

        for a description of the `X-DocuSign-Edit` header.


        ### Related topics


        - Common API Tasks: Locking and unlocking envelopes'
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeLocks_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getLock
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Lock_GetEnvelopeLock
    put:
      tags:
      - EnvelopeLocks
      summary: Updates an envelope lock
      description: 'Updates the lock information for a locked envelope.


        You must include the `X-DocuSign-Edit` header

        as described in

        EnvelopeLocks: create.


        Use this method to change the duration

        of the lock (`lockDurationInSeconds`)

        or the `lockedByApp` string.


        The request body is a full `lockRequest` object,

        but you only need to specify the

        properties that you are updating. For example:


        ```

        {

        "lockDurationInSeconds": "3600",

        "lockedByApp": "My Application"

        }

        ```'
      operationId: putV21AccountsByAccountIdEnvelopesByEnvelopeIdLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeLocks_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateLock
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lockRequest_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/lockRequest_2'
      x-operation-id-source: normalized
      x-operation-id-original: Lock_PutEnvelopeLock
    post:
      tags:
      - EnvelopeLocks
      summary: Locks an envelope
      description: 'This method locks the specified envelope and sets the time until

        the lock expires to prevent other users or recipients from

        changing the envelope.


        The response to this request includes a `lockToken` parameter

        that you must use in the `X-DocuSign-Edit` header for

        every PUT method (typically a method that updates an envelope)

        while the envelope is locked.


        If you do not provide the `lockToken` when accessing

        a locked envelope, you will get the following

        error:


        ```

        {

        "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER",

        "message": "The user is not the owner of the lock. The template is locked by another user or in another application"

        }

        ```


        ### The X-DocuSign-Edit header


        The `X-DocuSign-Edit` header looks like this

        and can be specified in either JSON or XML.


        **JSON**

        ```

        {

        "LockToken": "token-from-response",

        "LockDurationInSeconds": "600"

        }

        ```


        **XML**

        ```


        token-from-response

        600


        ```


        In the actual HTTP header, you would remove the linebreaks:


        ```

        X-DocuSign-Edit: {"LockToken": "token-from-response", "LockDurationInSeconds": "600" }

        or

        X-DocuSign-Edit:token-from-response600

        ```


        ### Related topics


        - Common API Tasks: Locking and unlocking envelopes'
      operationId: postV21AccountsByAccountIdEnvelopesByEnvelopeIdLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeLocks_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: createLock
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lockRequest_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/lockRequest_2'
      x-operation-id-source: normalized
      x-operation-id-original: Lock_PostEnvelopeLock
    delete:
      tags:
      - EnvelopeLocks
      summary: Deletes an envelope lock
      description: 'Deletes the lock from the specified envelope.

        The user deleting the lock must be the same user

        who locked the envelope.


        You must include the `X-DocuSign-Edit` header

        as described in

        EnvelopeLocks: create.


        This method takes an optional query parameter

        that lets you specify whether

        changes made while the envelope was locked

        are kept or discarded.


        | Query Parameter | Description |

        | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

        | `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |


        ### Related topics


        - Common API Tasks: Locking and unlocking envelopes'
      operationId: deleteV21AccountsByAccountIdEnvelopesByEnvelopeIdLock
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeLocks_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteLock
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Lock_DeleteEnvelopeLock
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    EnvelopeLocks:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        lockDurationInSeconds:
          type: string
          description: '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:
          type: string
          description: Specifies the friendly name of  the application that is locking the envelope.
        lockedByUser:
          $ref: '#/components/schemas/userInfo'
        lockedUntilDateTime:
          type: string
          description: The datetime until the envelope lock expires.
        lockToken:
          type: string
          description: A unique identifier provided to the owner of the envelope lock.   Used to prove ownership of the lock.
        lockType:
          type: string
          description: The type of envelope lock.  Currently "edit" is the only supported type.
        useScratchPad:
          type: string
          description: "Reserved for future use.\n\nIndicates whether a scratchpad is used for editing information.\n "
      description: Envelope locks
      x-ds-definition-name: lockInformation
      x-ds-category: Envelopes
      x-ds-order: '80'
      x-ms-summary: Envelope locks
    lockRequest:
      type: object
      properties:
        lockDurationInSeconds:
          type: string
          description: The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.
        lockedByApp:
          type: string
          description: A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur.
        lockType:
          type: string
          description: The type of envelope lock.  Currently "edit" is the only supported type.
        templatePassword:
          type: string
          description: ''
        useScratchPad:
          type: string
          description: "Reserved for future use.\n\nIndicates whether a scratchpad is used for editing information.\n "
      description: ''
      x-ds-definition-name: lockRequest
      x-ms-summary: ''
    userInfo:
      type: object
      properties:
        activationAccessCode:
          type: string
          description: ''
        email:
          type: string
          description: ''
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        loginStatus:
          type: string
          description: ''
        sendActivationEmail:
          type: string
          description: ''
        uri:
          type: string
          description: ''
        userId:
          type: string
          description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.'
        userName:
          type: string
          description: ''
        userStatus:
          type: string
          description: 'Status of the user''s account. One of:


            * ActivationRequired

            * ActivationSent

            * Active

            * Closed

            * Disabled

            '
        userType:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: userInfo
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    EnvelopeLocks_2:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        lockDurationInSeconds:
          description: '

            The number of seconds until the lock expires when there is no activity on the envelope.


            The default value is 300 seconds. The maximum value is 1,800 seconds.


            The lock duration can be extended.

            '
          type: string
        lockedByApp:
          description: The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.
          type: string
        lockedByUser:
          $ref: '#/components/schemas/userInfo_2'
          description: A complex type containing information about the user that has the envelope or template locked.
        lockedUntilDateTime:
          description: The date and time that the lock expires.
          type: string
        lockToken:
          description: A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
          type: string
        lockType:
          description: The type of lock.  Currently `edit` is the only supported type.
          type: string
        useScratchPad:
          description: "When **true,** a scratchpad is used to edit information.\n "
          type: string
      x-ds-definition-name: lockInformation
      description: 'Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.

        '
      x-ds-category: Envelopes
      x-ds-order: '80'
      x-ms-summary: 'Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.

        '
    lockRequest_2:
      type: object
      properties:
        lockDurationInSeconds:
          description: The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.
          type: string
        lockedByApp:
          description: A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur.
          type: string
        lockType:
          description: The type of lock.  Currently `edit` is the only supported type.
          type: string
        templatePassword:
          description: The [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes.
          type: string
        useScratchPad:
          description: "When **true,** a scratchpad is used to edit information.\n "
          type: string
      description: This request object contains information about the lock that you want to create or update.
      x-ds-definition-name: lockRequest
      x-ms-summary: This request object contains information about the lock that you want to create or update.
    userInfo_2:
      type: object
      properties:
        accountId:
          description: The account ID associated with the envelope.
          type: string
        accountName:
          description: The name on the account.
          type: string
        activationAccessCode:
          description: Access code provided to the user to activate the account.
          type: string
        email:
          description: The user's email address.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        ipAddress:
          description: ''
          type: string
        loginStatus:
          description: When **true,** indicates that the user is logged in. This is a read-only property.
          type: string
        membershipId:
          description: The user's membership ID.
          type: string
        sendActivationEmail:
          description: This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
          type: string
        uri:
          description: A URI containing the user ID.
          type: string
        userId:
          description: The ID of the user to access.
          type: string
        userName:
          description: The name of the user.
          type: string
        userStatus:
          description: 'Status of the user''s account. One of:


            - `ActivationRequired`

            - `ActivationSent`

            - `Active`

            - `Closed`

            - `Disabled`

            '
          type: string
        userType:
          description: The type of user, for example `CompanyUser`.
          type: string
      x-ds-definition-name: userInfo
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'