Skip to navigation

Send task to start workflows via bulk job

View as Markdown

Send a task to start workflows via bulk job

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

BulkWorkflowTask task definition containing a list of BulkWorkflowTaskItem.
NamestringOptional
The name of the BulkWorkflowTask.
DescriptionstringOptional
A description for the BulkWorkflowTask.
WorkflowDefinitionIdstringOptional
ID of the Workflow that this BulkWorkflowTask will start.
StatusstringOptional
Status of the BulkWorkflowTask.
TotalWorkflowCountintegerOptional
Total number of Workflows.
SuccessWorkflowCountintegerOptional
Number of successfully completed Workflows.
FailureWorkflowCountintegerOptional
Number of failed Workflows.
OutcomestringOptional
Outcome of the BulkWorkflowTask.
CompletedDatedatetimeOptional
Completion date of the BulkWorkflowTask.
CreatedDatedatetimeOptional
Creation date of the BulkWorkflowTask.
CreatedBystringOptional
Creator of the BulkWorkflowTask.
Itemslist of objectsOptional
BulkWorkflowTask items.
HrefstringOptional
Uri where the object can be retrieved.
DocumentobjectOptional
Document containing the data with which to start Workflows.

Response

OK
NamestringOptional
The name of the BulkWorkflowTask.
DescriptionstringOptional
A description for the BulkWorkflowTask.
WorkflowDefinitionIdstringOptional
ID of the Workflow that this BulkWorkflowTask will start.
StatusstringOptional
Status of the BulkWorkflowTask.
TotalWorkflowCountintegerOptional
Total number of Workflows.
SuccessWorkflowCountintegerOptional
Number of successfully completed Workflows.
FailureWorkflowCountintegerOptional
Number of failed Workflows.
OutcomestringOptional
Outcome of the BulkWorkflowTask.
CompletedDatedatetimeOptional
Completion date of the BulkWorkflowTask.
CreatedDatedatetimeOptional
Creation date of the BulkWorkflowTask.
CreatedBystringOptional
Creator of the BulkWorkflowTask.
Itemslist of objectsOptional
BulkWorkflowTask items.
HrefstringOptional
Uri where the object can be retrieved.
DocumentobjectOptional
Document containing the data with which to start Workflows.