v1

latestSwagger 2.02026-07-134146194.6 MB
Folders

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

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
put/v2.1/accounts/{accountId}/folders/{folderId}

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

folderIdstring required

The ID of the folder.

Request body

envelopeIdsstring[]

An array of envelope ID GUIDs.

fromFolderIdstring

The ID of the folder that the envelope is being moved from.

Response

Successful response.