Appearance
docusign.envelope-workflow-definition.put-template-workflow-definition ​
Updates the specified template's workflow definition.
Updates the workflow definition for a template.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-docusign |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Docusign API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
accountid | string | Yes | — | The external account number (int) or account ID GUID. |
templateid | string | Yes | — | The ID of the template. |
currentworkflowstepid | string | No | — | The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object. |
resumedate | string | No | — | The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep. This property is read-only. |
scheduledsending | json | No | — | A complex element that specifies the scheduled sending settings for the envelope. |
workflowstatus | string | No | — | The status of the workflow: - paused if the workflow is paused - in_progress if the workflow is in progress |
workflowsteps | list | No | — | An array of workflow steps. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Docusign API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
accountid | string | Yes | — | The external account number (int) or account ID GUID. |
templateid | string | Yes | — | The ID of the template. |
currentworkflowstepid | string | No | — | The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object. |
resumedate | string | No | — | The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep. This property is read-only. |
scheduledsending | json | No | — | A complex element that specifies the scheduled sending settings for the envelope. |
workflowstatus | string | No | — | The status of the workflow: - paused if the workflow is paused - in_progress if the workflow is in progress |
workflowsteps | list | No | — | An array of workflow steps. |
status_code | integer | No | — | HTTP status code of the completed call |
response | json | No | — | Parsed JSON response body |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_at | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | Waiting to call PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow |
completed | No | Yes | Yes | — | HTTP call succeeded |
failed | No | Yes | No | — | HTTP call failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | Perform PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow |
* (any state) | fail | failed | Record the failure reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "docusign.envelope-workflow-definition.put-template-workflow-definition",
"initial_data": {
"base_url": "value",
"accountid": "value",
"templateid": "value"
}
}