Skip to navigation

Copy documents/folders

View as Markdown

Submit an asynchronous task to copy documents/folders to a specified folder.

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Request

CopyTask object definition containing the list of documents and/or folders to copy and the destination folder.

DocumentsToCopylist of objectsOptional
Documents to copy
FoldersToCopylist of objectsOptional
Folders to copy
DocumentResultslist of objectsOptional
Resulting document copies created by the task
FolderResultslist of objectsOptional
Resulting folder copies created by the task
FailedDocumentslist of objectsOptional
Documents that could not be copied and reasons
FailedFolderslist of objectsOptional
Folders that could not be copied and reasons
MessagestringOptional

Additional explanation of the status (if any)

DownloadUrlstringOptional
The URI where the document can be downloaded, if no destination folder is provided
DestinationDocumentNamestringOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the name of the new document
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
ResultDocumentobjectOptional
The document that is created as a result of this task
DestinationFolderobjectOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the folder where the new document should be placed

Response

OK
DocumentsToCopylist of objectsOptional
Documents to copy
FoldersToCopylist of objectsOptional
Folders to copy
DocumentResultslist of objectsOptional
Resulting document copies created by the task
FolderResultslist of objectsOptional
Resulting folder copies created by the task
FailedDocumentslist of objectsOptional
Documents that could not be copied and reasons
FailedFolderslist of objectsOptional
Folders that could not be copied and reasons
MessagestringOptional

Additional explanation of the status (if any)

DownloadUrlstringOptional
The URI where the document can be downloaded, if no destination folder is provided
DestinationDocumentNamestringOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the name of the new document
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
ResultDocumentobjectOptional
The document that is created as a result of this task
DestinationFolderobjectOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the folder where the new document should be placed