docusign.folders.put-folder-by-id

Moves a set of envelopes from their current folder to another folder. The folderId path parameter is the destination folder. The request body has an array of envelope IDs and the ID of the source folder. <ds-inlinemessage kind="warning" markdown="1"> Do not use the <code>folders</code> property in the request body. </ds-inlinemessage> If folderId is the special value recyclebin the envelopes are moved to the Deleted folder. Moving an in-process envelope (envelope status of sent or delivered) to the recyclebin voids the envelope. ### Related topics - Searching for envelopes - Sharing templates

Moves a set of envelopes from their current folder to another folder.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
folderid	string	Yes	—	The ID of the folder.
envelopeids	list	No	—	An array of envelope ID GUIDs.
folders	list	No	—	Not used.
fromfolderid	string	No	—	The ID of the folder that the envelope is being moved from.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
folderid	string	Yes	—	The ID of the folder.
envelopeids	list	No	—	An array of envelope ID GUIDs.
folders	list	No	—	Not used.
fromfolderid	string	No	—	The ID of the folder that the envelope is being moved from.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/folders/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/folders/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.folders.put-folder-by-id",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "folderid": "value"
  }
}