Request

HTTP request

PUT /restapi/v2.1/accounts/{accountId}/settings/enote_configuration

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Request Body

eNoteConfiguration

Responses

CodeDescriptionReference
200

Successful response.

eNoteConfiguration
400

Error encountered.

errorDetails

SDK Method

Accounts::updateENoteConfiguration

Definitions

eNoteConfiguration

This object contains information used to configure eNote functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly.

connectConfiguredstring

When false, the user must configure Connect and eOriginal for the integration to work.

eNoteConfiguredstring

When false, the user must configure eNote for the feature to work.

Note: In the account settings, allowENoteEOriginal must be set to true to make changes to the configuration.

organizationstring

The name of the organization.

passwordstring

The user's encrypted password hash.

userNamestring

The user's username.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Request/Response

Request
{
  "connectConfigured": "sample string 1",
  "eNoteConfigured": "sample string 2",
  "organization": "sample string 3",
  "userName": "sample string 4",
  "password": "sample string 5"
}
Response
{
  "connectConfigured": "sample string 1",
  "eNoteConfigured": "sample string 2",
  "organization": "sample string 3",
  "userName": "sample string 4"
}
Generic XML Request/Response

Request
<eNoteConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <connectConfigured>sample string 1</connectConfigured>
  <eNoteConfigured>sample string 2</eNoteConfigured>
  <organization>sample string 3</organization>
  <password>sample string 5</password>
  <userName>sample string 4</userName>
</eNoteConfiguration> 
Response
<eNoteConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <connectConfigured>sample string 1</connectConfigured>
  <eNoteConfigured>sample string 2</eNoteConfigured>
  <organization>sample string 3</organization>
  <userName>sample string 4</userName>
</eNoteConfiguration> 
}} />