Skip to navigation

ClickWraps Resource

View as Markdown

Methods for working with elastic templates and elastic signing agreements.

Methods supported

MethodDescription
createBulkClickwrapAgreementsPOST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/bulk_agreements
Starts an export of clickwrap agreements for a specified date range.
createClickwrapPOST /clickapi/v1/accounts/{accountId}/clickwraps
Creates an elastic template for an account.
createClickwrapVersionPOST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions
Creates a new elastic template version.
createHasAgreedPOST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements
Creates a unique URL for the agreement that you can embed in your application.
deleteClickwrapDEL /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}
Deletes an elastic template and all of its versions.
deleteClickwrapsDEL /clickapi/v1/accounts/{accountId}/clickwraps
Deletes elastic templates for an account.
deleteClickwrapVersionDEL /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}
Deletes an elastic template version by version ID.
deleteClickwrapVersionsDEL /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions
Deletes the versions of an elastic template.
getAgreementGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}
Gets a specific agreement for a specified elastic template.
getAgreementDocumentGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/documents/{orderOrDisclosure}
Downloads a document at an order within the agreement.
getAgreementPdfGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}/download
Gets the completed user agreement PDF.
getClickwrapGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}
Gets a single elastic template object.
getClickwrapAgreementsGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/users
Get elastic signing agreements.
getClickwrapsGET /clickapi/v1/accounts/{accountId}/clickwraps
Gets all the elastic templates for a user.
getClickwrapVersionGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}
Gets a specific version of an elastic template by version ID.
getClickwrapVersionAgreementsGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users
Gets the agreement responses for an elastic template version by version ID.
getClickwrapVersionsGET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions
Gets all the versions of an elastic template.
getServiceInformationGET /clickapi/service_information
Gets the current version and other information about the Click API.
updateClickwrapPUT /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}
Update properties of an elastic template.
updateClickwrapVersionPUT /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}
Update properties of an elastic template by its version ID.