{
  "opencollection": "1.0.0",
  "info": {
    "name": "DocuSign Admin AccountBrands ClickWraps API",
    "version": "v2.1"
  },
  "items": [
    {
      "info": {
        "name": "ClickWraps",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Docusign Gets the current version and other information about the Click API.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/service_information"
          },
          "docs": "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```"
        },
        {
          "info": {
            "name": "Docusign Gets all the clickwraps for an account.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "from_date",
                "value": "",
                "type": "query",
                "description": "Optional. The earliest date to return agreements from."
              },
              {
                "name": "ownerUserId",
                "value": "",
                "type": "query",
                "description": "Optional. The user ID of the owner."
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Optional. The page number to return.\n"
              },
              {
                "name": "shared",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Optional. The status of the clickwraps to filter by. One of:\n\n- `active`\n- `inactive`\n\n"
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query",
                "description": "Optional. The latest date to return agreements from."
              }
            ]
          },
          "docs": "Gets all the clickwraps for an account.\n"
        },
        {
          "info": {
            "name": "Docusign Creates a clickwrap for an account.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a clickwrap for an account and returns the response with created agreement.\n"
        },
        {
          "info": {
            "name": "Docusign Deletes clickwraps for an account.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapIds",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of clickwrap IDs to delete."
              }
            ]
          },
          "docs": "Deletes all clickwraps for an account\nor only the ones specified in the\n`clickwrapIds` query parameter.\n"
        },
        {
          "info": {
            "name": "Docusign Gets a  single clickwrap object.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ]
          },
          "docs": "Gets a  single clickwrap object."
        },
        {
          "info": {
            "name": "Docusign Updates the user ID of a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the user ID of a clickwrap. You specify the old and the new user ID in the request body."
        },
        {
          "info": {
            "name": "Docusign Deletes a clickwrap and all of its versions.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versions",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of versions to delete."
              }
            ]
          },
          "docs": "Deletes the clickwrap specified by `clickwrapId` and all of its versions.\nActive clickwraps are not deleted"
        },
        {
          "info": {
            "name": "Docusign Checks if a user has agreed to a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/agreements",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Checks if a user has agreed to a clickwrap and returns a response with the agreement URL.\n\nReturns HTTP status code OK if the user has no pending agreement.\n"
        },
        {
          "info": {
            "name": "Docusign Gets a specific agreement for a specified clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/agreements/:agreementId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "agreementId",
                "value": "",
                "type": "path",
                "description": "The agreement ID."
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ]
          },
          "docs": "Gets the agreement specified by `agreementId`.\n\nYou can omit `agreementId` to get the latest agreement."
        },
        {
          "info": {
            "name": "Docusign Gets the completed user agreement PDF.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/agreements/:agreementId/download",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "agreementId",
                "value": "",
                "type": "path",
                "description": "The agreement ID."
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ]
          },
          "docs": "Gets the PDF of  `agreementId` for the clickwrap specified by `ciickwrapId`.\n\nThe response to this method is the bytes of the PDF file.\nThe response includes the HTTP header `application/pdf."
        },
        {
          "info": {
            "name": "Docusign Get user agreements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/users",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "client_user_id",
                "value": "",
                "type": "query",
                "description": "The client ID.\n"
              },
              {
                "name": "from_date",
                "value": "",
                "type": "query",
                "description": "Optional. The earliest date to return agreements from."
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Optional. The page number to return.\n"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Optional. The status of the clickwraps to return."
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query",
                "description": "Optional. The latest date to return agreements from."
              }
            ]
          },
          "docs": "Get user agreements\n"
        },
        {
          "info": {
            "name": "Docusign Creates a new clickwrap version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new clickwrap version."
        },
        {
          "info": {
            "name": "Docusign Deletes the versions of a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "clickwrapVersionIds",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of clickwrap version IDs to delete."
              }
            ]
          },
          "docs": "Deletes all versions of a clickwrap,\nor only the ones specified in the\n`clickwrapVersionIds` query parameter."
        },
        {
          "info": {
            "name": "Docusign Gets a specific version from a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The ID of the version."
              }
            ]
          },
          "docs": "Gets the version specified by `versionId`  from the clickwrap `clickwrapId`."
        },
        {
          "info": {
            "name": "Docusign Updates a specific version of a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The ID of the version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the clickwrap version `versionId` of the clickwrap `clickwrapId`."
        },
        {
          "info": {
            "name": "Docusign Deletes a specific version of a clickwrap.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The ID of the version."
              }
            ]
          },
          "docs": "Deletes the clickwrap version `versionId` of the clickwrap `clickwrapId`."
        },
        {
          "info": {
            "name": "Docusign Gets the agreement responses for a clickwrap version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionId/users",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The ID of the version."
              },
              {
                "name": "client_user_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "from_date",
                "value": "",
                "type": "query",
                "description": "Optional. The earliest date to return agreements from."
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Optional. The page number to return.\n"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Clickwrap status. Possible values:\n\n- `active`\n- `inactive`\n- `deleted`"
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query",
                "description": "Optional. The latest date to return agreements from."
              }
            ]
          },
          "docs": "Gets the agreement responses for a specific version. "
        },
        {
          "info": {
            "name": "Docusign Gets a clickwrap version by specifying its version number.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumber",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "Version of the clickwrap."
              }
            ]
          },
          "docs": "Gets the clickwrap version specified by `versionNumber` from the clickwrap `clickwrapId`."
        },
        {
          "info": {
            "name": "Docusign Updates a clickwrap version by specifying its version number.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumber",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "Version of the clickwrap."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the clickwrap version specified by `versionNumber` of the clickwrap `clickwrapId`.\n"
        },
        {
          "info": {
            "name": "Docusign Deletes a clickwrap version from a clickwrap by specifying its version number.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumber",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "Version of the clickwrap."
              }
            ]
          },
          "docs": "Deletes the clickwrap version specified by `versionNumber` from the clickwrap `clickwrapId`.\n"
        },
        {
          "info": {
            "name": "Docusign Gets the agreement responses for a clickwrap version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumber/users",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "A GUID that identifies your account.\nThis value is automatically generated by\nDocuSign for any account you create. Copy the\nvalue from the **API Account ID** field in\nthe **API and Keys** page in\neSignature Settings.\n"
              },
              {
                "name": "clickwrapId",
                "value": "",
                "type": "path",
                "description": "The ID of the clickwrap."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "Version of the clickwrap."
              },
              {
                "name": "client_user_id",
                "value": "",
                "type": "query",
                "description": "The client user ID."
              },
              {
                "name": "from_date",
                "value": "",
                "type": "query",
                "description": "Optional. The earliest date to return agreements from."
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Optional. The page number to return.\n"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Clickwrap status. Possible values:\n\n- `active`\n- `inactive`\n- `deleted`"
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query",
                "description": "Optional. The latest date to return agreements from."
              }
            ]
          },
          "docs": "Gets the agreement responses for a clickwrap version"
        }
      ]
    }
  ],
  "bundled": true
}