Start workflow instance by definition name
Name property of workflow object must match the name of a workflow definition in the designer.
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
accountId
The ID of the Docusign account.
Request
Workflow object definition, containing XML parameters and documents to start a workflow instance.
Name
The name of the workflow as given in the workflow designer. Required when starting a new workflow
StartDate
Date and time the workflow was started
EndDate
Date and time the workflow ended. Null if the workflow has not yet ended
Status
Status of the workflow. Possible values include: Execution Pending, Executing, Waiting, Completed, Paused, Failed, Aborted
Info
Additional information associated with the workflow
Params
XML data used when starting the workflow. Only used when starting a new workflow
Href
Uri where the object can be retrieved.
WorkflowDocuments
Documents passed when starting a workflow. Only used when starting a new workflow
Response
OK
Name
The name of the workflow as given in the workflow designer. Required when starting a new workflow
StartDate
Date and time the workflow was started
EndDate
Date and time the workflow ended. Null if the workflow has not yet ended
Status
Status of the workflow. Possible values include: Execution Pending, Executing, Waiting, Completed, Paused, Failed, Aborted
Info
Additional information associated with the workflow
Params
XML data used when starting the workflow. Only used when starting a new workflow
Href
Uri where the object can be retrieved.
WorkflowDocuments
Documents passed when starting a workflow. Only used when starting a new workflow