docusign.e-note-configurations.put-e-note-configuration ​
Updates configuration information for the eNote eOriginal integration.
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. |
apikey | string | No | — | — |
connectconfigured | string | No | — | When false, the user must configure Connect and eOriginal for the integration to work. |
enoteconfigured | string | No | — | When false, the user must configure eNote for the feature to work. Note: In the account settings, allowENoteEOriginal must be true to make changes to the configuration. |
organization | string | No | — | The name of the organization. |
password | string | No | — | The user's password. This property is used only when adding a new user via a Users: create request. The value must conform to the password rules defined in the account Security Settings. This property is not returned by GET requests and cannot be updated via PUT requests. |
username | string | No | — | The user's username. |
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. |
apikey | string | No | — | — |
connectconfigured | string | No | — | When false, the user must configure Connect and eOriginal for the integration to work. |
enoteconfigured | string | No | — | When false, the user must configure eNote for the feature to work. Note: In the account settings, allowENoteEOriginal must be true to make changes to the configuration. |
organization | string | No | — | The name of the organization. |
password | string | No | — | The user's password. This property is used only when adding a new user via a Users: create request. The value must conform to the password rules defined in the account Security Settings. This property is not returned by GET requests and cannot be updated via PUT requests. |
username | string | No | — | The user's username. |
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}/settings/enote_configuration |
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}/settings/enote_configuration |
* (any state) | fail | failed | Record the failure reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "docusign.e-note-configurations.put-e-note-configuration",
"initial_data": {
"base_url": "value",
"accountid": "value"
}
}