{
  "opencollection": "1.0.0",
  "info": {
    "name": "DocuSign Admin AccountBrands EnvelopeLocks API",
    "version": "v2.1"
  },
  "items": [
    {
      "info": {
        "name": "EnvelopeLocks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Docusign Gets envelope lock information.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/lock",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              }
            ]
          },
          "docs": "Retrieves general information about the envelope lock.\n\nIf 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."
        },
        {
          "info": {
            "name": "Docusign Lock an envelope.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/lock",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.\n\n###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be  set to true for the user)."
        },
        {
          "info": {
            "name": "Docusign Updates an envelope lock.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/lock",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Docusign Deletes an envelope lock.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/lock",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              }
            ]
          },
          "docs": "Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request."
        }
      ]
    }
  ],
  "bundled": true
}