Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "lockedByApp": "sample string 1",
' "lockDurationInSeconds": "sample string 2",
' "lockType": "sample string 3",
' "useScratchPad": "sample string 4",
' "templatePassword": "sample string 5"
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("lockedByApp","sample string 1")
json.UpdateString("lockDurationInSeconds","sample string 2")
json.UpdateString("lockType","sample string 3")
json.UpdateString("useScratchPad","sample string 4")
json.UpdateString("templatePassword","sample string 5")
' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/lock","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"lockedByApp": "sample string 1",
"lockDurationInSeconds": "sample string 2",
"lockType": "sample string 3",
"useScratchPad": "sample string 4",
"templatePassword": "sample string 5"
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/lock
Postman Collection Item JSON
{
"name": "Lock an envelope.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"lockedByApp\": \"sample string 1\",\n \"lockDurationInSeconds\": \"sample string 2\",\n \"lockType\": \"sample string 3\",\n \"useScratchPad\": \"sample string 4\",\n \"templatePassword\": \"sample string 5\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/lock",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"envelopes",
"{{envelopeId}}",
"lock"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "envelopeId",
"value": "{{envelopeId}}",
"type": "string"
}
]
},
"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.\n\n###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user)."
},
"response": [
]
}