Chilkat Online Tools

autoit / DocuSign REST API / Moves an envelope from its current folder to the specified folder.

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "envelopeIds": [
;     "sample string 1"
;   ],
;   "fromFolderId": "sample string 1"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("envelopeIds[0]","sample string 1")
$oJson.UpdateString("fromFolderId","sample string 1")

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/folders/{{folderId}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "envelopeIds": [
    "sample string 1"
  ],
  "fromFolderId": "sample string 1"
}'
https://domain.com/v2.1/accounts/{{accountId}}/folders/{{folderId}}

Postman Collection Item JSON

{
  "name": "Moves an envelope from its current folder to the specified folder.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"envelopeIds\": [\n    \"sample string 1\"\n  ],\n  \"fromFolderId\": \"sample string 1\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/folders/{{folderId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "folders",
        "{{folderId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}"
        }
      ]
    },
    "description": "Moves envelopes to the specified folder."
  },
  "response": [
  ]
}