Docusign ENoteConfigurations API

openapi: 3.2.0
info:
  title: Docusign E Note Configurations API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged ENoteConfigurations across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: ENoteConfigurations
  description: 'The ENoteConfigurations resource provides methods that allow you to manage

    information for the eNote eOriginal integration.'
paths:
  /v2/accounts/{accountId}/settings/enote_configuration:
    get:
      tags:
      - ENoteConfigurations
      summary: Docusign Returns the configuration information for the eNote eOriginal…
      operationId: ENoteConfiguration_GetENoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/eNoteConfiguration'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getENoteConfiguration
      x-ds-api-status: beta
      x-ds-method: get
      x-ds-service: Accounts
      x-ds-in-sdk: true
    put:
      tags:
      - ENoteConfigurations
      summary: Docusign Updates configuration information for the eNote eOriginal integration
      operationId: ENoteConfiguration_PutENoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eNoteConfiguration'
          application/xml:
            schema:
              $ref: '#/components/schemas/eNoteConfiguration'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/eNoteConfiguration'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateENoteConfiguration
      x-ds-api-status: beta
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-codegen-request-body-name: eNoteConfiguration
    delete:
      tags:
      - ENoteConfigurations
      summary: Docusign Deletes configuration information for the eNote eOriginal integration
      operationId: ENoteConfiguration_DeleteENoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content: {}
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteENoteConfiguration
      x-ds-api-status: beta
      x-ds-method: delete
      x-ds-service: Accounts
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/settings/enote_configuration:
    parameters: []
    get:
      tags:
      - ENoteConfigurations
      summary: Returns the configuration information for the eNote eOriginal integration
      operationId: getV21AccountsByAccountIdSettingsEnoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eNoteConfiguration_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getENoteConfiguration
      x-ds-api-status: beta
      description: ''
      x-ds-method: get
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ENoteConfiguration_GetENoteConfiguration
    put:
      tags:
      - ENoteConfigurations
      summary: Updates configuration information for the eNote eOriginal integration
      operationId: putV21AccountsByAccountIdSettingsEnoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eNoteConfiguration_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateENoteConfiguration
      x-ds-api-status: beta
      description: ''
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eNoteConfiguration_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/eNoteConfiguration_2'
      x-operation-id-source: normalized
      x-operation-id-original: ENoteConfiguration_PutENoteConfiguration
    delete:
      tags:
      - ENoteConfigurations
      summary: Deletes configuration information for the eNote eOriginal integration
      operationId: deleteV21AccountsByAccountIdSettingsEnoteConfiguration
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteENoteConfiguration
      x-ds-api-status: beta
      description: ''
      x-ds-method: delete
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ENoteConfiguration_DeleteENoteConfiguration
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    eNoteConfiguration:
      type: object
      properties:
        connectConfigured:
          type: string
          description: ''
        eNoteConfigured:
          type: string
          description: ''
        organization:
          type: string
          description: ''
        password:
          type: string
          description: ''
        userName:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: eNoteConfiguration
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    eNoteConfiguration_2:
      type: object
      properties:
        apiKey:
          description: ''
          type: string
        connectConfigured:
          description: When **false,** the user must configure Connect and eOriginal for the integration to work.
          type: string
        eNoteConfigured:
          description: '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.'
          type: string
        organization:
          description: The name of the organization.
          type: string
        password:
          description: 'The user''s password.


            This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).


            This property is not returned by `GET` requests and cannot be updated via `PUT` requests.'
          type: string
        userName:
          description: The user's username.
          type: string
      description: 'This object contains information used to

        configure [eNote][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.


        [eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html

        '
      x-ds-definition-name: eNoteConfiguration
      x-ms-summary: 'This object contains information used to

        configure [eNote][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.


        [eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html

        '
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'