Skip to navigation

Create DocLauncher task

View as Markdown

Submit an asynchronous task to create an instance of a DocLauncher using the configuration and data specified in your POST.

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

DocLauncherTask object definition containing the configuration and destination folder.
DatastringOptional
The actual json or xml set of data that will be used by DocLauncher
DataTypestringOptional

The type of content found in the Data property, valid values are [json|xml]

UrlExpirationDatedatetimeOptional
The date and time in UTC in which the DocumentLauncherResultUrl will expire
DocLauncherResultUrlstringOptional
The URL for the instance of DocLauncher that was created by this task
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
DestinationFolderobjectOptional
The Folder that will receive the output of DocLauncher's packaged contents. This will override the DestinationFolder property of the DocLauncherConfiguration.
DocLauncherConfigurationobjectOptional
The DocLauncherConfiguration to use for this DocLauncher

Response

OK
DatastringOptional
The actual json or xml set of data that will be used by DocLauncher
DataTypestringOptional

The type of content found in the Data property, valid values are [json|xml]

UrlExpirationDatedatetimeOptional
The date and time in UTC in which the DocumentLauncherResultUrl will expire
DocLauncherResultUrlstringOptional
The URL for the instance of DocLauncher that was created by this task
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
DestinationFolderobjectOptional
The Folder that will receive the output of DocLauncher's packaged contents. This will override the DestinationFolder property of the DocLauncherConfiguration.
DocLauncherConfigurationobjectOptional
The DocLauncherConfiguration to use for this DocLauncher