Docusign ClickWraps API

openapi: 3.0.1
info:
  title: DocuSign Admin AccountBrands ClickWraps API
  description: An API for an organization administrator to manage organizations, accounts and users
  termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
  contact:
    name: DocuSign Developer Center
    url: https://developers.docusign.com
    email: devcenter@docusign.com
  version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: ClickWraps
  description: ''
paths:
  /service_information:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets the current version and other information about the Click API.
      description: "The response includes information about the version of the Click API.\n\n```\n{\n  \"serviceVersions\": [\n    {\n      \"version\": \"v1\",\n      \"versionUrl\": \"https://demo.docusign.net/clickapi/v1\"\n    }\n  ],\n  \"buildVersion\": \"20.4.0.16708 (20.4.00.00_newt.16708+g236a94)\",\n  \"linkedSites\": [\n    \"https://demo.docusign.net\"\n  ]\n}\n```"
      operationId: ServiceInformation_GetServiceInformation
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/serviceInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getServiceInformation
      x-ds-method: getServiceInformation
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets all the clickwraps for an account.
      description: 'Gets all the clickwraps for an account.

        '
      operationId: Clickwraps_GetClickwraps
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: from_date
        in: query
        description: Optional. The earliest date to return agreements from.
        schema:
          type: string
      - name: ownerUserId
        in: query
        description: Optional. The user ID of the owner.
        schema:
          type: string
      - name: page_number
        in: query
        description: 'Optional. The page number to return.

          '
        schema:
          type: string
      - name: shared
        in: query
        schema:
          type: string
      - name: status
        in: query
        description: 'Optional. The status of the clickwraps to filter by. One of:


          - `active`

          - `inactive`


          '
        schema:
          type: string
      - name: to_date
        in: query
        description: Optional. The latest date to return agreements from.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionsResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwraps
      x-ds-method: getClickwraps
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    post:
      tags:
      - ClickWraps
      summary: Docusign Creates a clickwrap for an account.
      description: 'Creates a clickwrap for an account and returns the response with created agreement.

        '
      operationId: Clickwraps_PostClickwrap
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionSummaryResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createClickwrap
      x-ds-method: createClickwrap
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-codegen-request-body-name: clickwrapRequest
    delete:
      tags:
      - ClickWraps
      summary: Docusign Deletes clickwraps for an account.
      description: 'Deletes all clickwraps for an account

        or only the ones specified in the

        `clickwrapIds` query parameter.

        '
      operationId: Clickwraps_DeleteClickwraps
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapIds
        in: query
        description: A comma-separated list of clickwrap IDs to delete.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapsDeleteResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteClickwraps
      x-ds-method: deleteClickwraps
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets a  single clickwrap object.
      description: Gets a  single clickwrap object.
      operationId: Clickwraps_GetClickwrap
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwrap
      x-ds-method: getClickwrap
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - ClickWraps
      summary: Docusign Updates the user ID of a clickwrap.
      description: Updates the user ID of a clickwrap. You specify the old and the new user ID in the request body.
      operationId: Clickwraps_PutClickwrap
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clickwrapTransferRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/clickwrapTransferRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionSummaryResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateClickwrap
      x-ds-method: updateClickwrap
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-codegen-request-body-name: clickwrapTransferRequest
    delete:
      tags:
      - ClickWraps
      summary: Docusign Deletes a clickwrap and all of its versions.
      description: 'Deletes the clickwrap specified by `clickwrapId` and all of its versions.

        Active clickwraps are not deleted'
      operationId: Clickwraps_DeleteClickwrap
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versions
        in: query
        description: A comma-separated list of versions to delete.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionsDeleteResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteClickwrap
      x-ds-method: deleteClickwrap
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements:
    post:
      tags:
      - ClickWraps
      summary: Docusign Checks if a user has agreed to a clickwrap.
      description: 'Checks if a user has agreed to a clickwrap and returns a response with the agreement URL.


        Returns HTTP status code OK if the user has no pending agreement.

        '
      operationId: UserAgreements_PostHasAgreed
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/userAgreementRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/userAgreementRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/userAgreementResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createHasAgreed
      x-ds-method: createHasAgreed
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-codegen-request-body-name: userAgreementRequest
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets a specific agreement for a specified clickwrap.
      description: 'Gets the agreement specified by `agreementId`.


        You can omit `agreementId` to get the latest agreement.'
      operationId: UserAgreements_GetAgreement
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: agreementId
        in: path
        description: The agreement ID.
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/userAgreementResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAgreement
      x-ds-method: getAgreement
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}/download:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets the completed user agreement PDF.
      description: 'Gets the PDF of  `agreementId` for the clickwrap specified by `ciickwrapId`.


        The response to this method is the bytes of the PDF file.

        The response includes the HTTP header `application/pdf.'
      operationId: UserAgreements_GetAgreementPdf
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: agreementId
        in: path
        description: The agreement ID.
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        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: getAgreementPdf
      x-ds-method: getAgreementPdf
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/users:
    get:
      tags:
      - ClickWraps
      summary: Docusign Get user agreements
      description: 'Get user agreements

        '
      operationId: UserAgreements_GetClickwrapAgreements
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: client_user_id
        in: query
        description: 'The client ID.

          '
        schema:
          type: string
      - name: from_date
        in: query
        description: Optional. The earliest date to return agreements from.
        schema:
          type: string
      - name: page_number
        in: query
        description: 'Optional. The page number to return.

          '
        schema:
          type: string
      - name: status
        in: query
        description: Optional. The status of the clickwraps to return.
        schema:
          type: string
      - name: to_date
        in: query
        description: Optional. The latest date to return agreements from.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapAgreementsResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwrapAgreements
      x-ds-method: getClickwrapAgreements
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions:
    post:
      tags:
      - ClickWraps
      summary: Docusign Creates a new clickwrap version.
      description: Creates a new clickwrap version.
      operationId: ClickwrapVersions_PostClickwrapVersion
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionSummaryResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createClickwrapVersion
      x-ds-method: createClickwrapVersion
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-codegen-request-body-name: clickwrapRequest
    delete:
      tags:
      - ClickWraps
      summary: Docusign Deletes the versions of a clickwrap.
      description: 'Deletes all versions of a clickwrap,

        or only the ones specified in the

        `clickwrapVersionIds` query parameter.'
      operationId: ClickwrapVersions_DeleteClickwrapVersions
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: clickwrapVersionIds
        in: query
        description: A comma-separated list of clickwrap version IDs to delete.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionsDeleteResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteClickwrapVersions
      x-ds-method: deleteClickwrapVersions
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets a specific version from a clickwrap.
      description: Gets the version specified by `versionId`  from the clickwrap `clickwrapId`.
      operationId: ClickwrapVersions_GetClickwrapVersion
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionId
        in: path
        description: The ID of the version.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwrapVersion
      x-ds-method: getClickwrapVersion
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - ClickWraps
      summary: Docusign Updates a specific version of a clickwrap.
      description: Updates the clickwrap version `versionId` of the clickwrap `clickwrapId`.
      operationId: ClickwrapVersions_PutClickwrapVersion
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionId
        in: path
        description: The ID of the version.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionSummaryResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateClickwrapVersion
      x-ds-method: updateClickwrapVersion
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-codegen-request-body-name: clickwrapRequest
    delete:
      tags:
      - ClickWraps
      summary: Docusign Deletes a specific version of a clickwrap.
      description: Deletes the clickwrap version `versionId` of the clickwrap `clickwrapId`.
      operationId: ClickwrapVersions_DeleteClickwrapVersion
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionId
        in: path
        description: The ID of the version.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionDeleteResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteClickwrapVersion
      x-ds-method: deleteClickwrapVersion
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets the agreement responses for a clickwrap version.
      description: 'Gets the agreement responses for a specific version. '
      operationId: UserAgreements_GetClickwrapVersionAgreements
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionId
        in: path
        description: The ID of the version.
        required: true
        schema:
          type: string
      - name: client_user_id
        in: query
        schema:
          type: string
      - name: from_date
        in: query
        description: Optional. The earliest date to return agreements from.
        schema:
          type: string
      - name: page_number
        in: query
        description: 'Optional. The page number to return.

          '
        schema:
          type: string
      - name: status
        in: query
        description: 'Clickwrap status. Possible values:


          - `active`

          - `inactive`

          - `deleted`'
        schema:
          type: string
      - name: to_date
        in: query
        description: Optional. The latest date to return agreements from.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapAgreementsResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwrapVersionAgreements
      x-ds-method: getClickwrapVersionAgreements
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}:
    get:
      tags:
      - ClickWraps
      summary: Docusign Gets a clickwrap version by specifying its version number.
      description: Gets the clickwrap version specified by `versionNumber` from the clickwrap `clickwrapId`.
      operationId: ClickwrapVersions_GetClickwrapVersionByNumber
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionNumber
        in: path
        description: Version of the clickwrap.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getClickwrapVersionByNumber
      x-ds-method: getClickwrapVersionByNumber
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - ClickWraps
      summary: Docusign Updates a clickwrap version by specifying its version number.
      description: 'Updates the clickwrap version specified by `versionNumber` of the clickwrap `clickwrapId`.

        '
      operationId: ClickwrapVersions_PutClickwrapVersionByNumber
      parameters:
      - name: accountId
        in: path
        description: 'A GUID that identifies your account.

          This value is automatically generated by

          DocuSign for any account you create. Copy the

          value from the **API Account ID** field in

          the **API and Keys** page in

          eSignature Settings.

          '
        required: true
        schema:
          type: string
      - name: clickwrapId
        in: path
        description: The ID of the clickwrap.
        required: true
        schema:
          type: string
      - name: versionNumber
        in: path
        description: Version of the clickwrap.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/clickwrapRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/clickwrapVersionSummaryResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/compo

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/docusign/refs/heads/main/openapi/docusign-clickwraps-api-openapi.yml