Skip to navigation
Docusign Click APIAccountsClickWraps

Create elastic template

View as Markdown

Creates an elastic template for an account and returns the response with created agreement.

The resulting elastic template has its status property set to draft, and the versionNumber is 1.0.

{
    "accountId": ""624e3e00-xxxx-xxxx-xxxx-43918c520dab",
    "clickwrapId": ""c3197231-xxxx-xxxx-xxxx-6f34186eee23",
    "clickwrapName": "HTML Only",
    "versionId": ""e27b59e2-xxxx-xxxx-xxxx-6a3b8b012ee8",
    "versionNumber": "1.0",
    "status": "draft",
    "createdTime": "2023-02-09T19:20:09.2150957Z",
    "lastModified": "2023-02-09T19:20:09.2150957Z",
    "lastModifiedBy": ""7c430bdb-xxxx-xxxx-xxxx-538c11111ff7",
    "ownerUserId": ""7c430bdb-xxxx-xxxx-xxxx-538c11111ff7",
    "draftVersionId": ""e27b59e2-xxxx-xxxx-xxxx-6a3b8b012ee8",
    "owner": {
        "userId": ""7c430bdb-xxxx-xxxx-xxxx-538c11111ff7",
        "userName": "Catherine Earnshaw",
        "email": "catherine@example.com"
    },
    "dataFields": []
}

Use ClickWraps: updateClickwrap with a request body like this to make the elastic template active:

{
"status": "active"
}

Required authentication scopes: click.manage.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: clickwrapRequest

clickwrapNamestringOptional

The name of the elastic template.

Required in ClickWraps: createClickwrap.

dataFieldslist of objectsOptional
An array of data fields available to be inserted into the documents.
displaySettingsobjectOptional
Information about how an agreement is displayed.
documentslist of objectsOptional
An array of documents. This object is required.
fieldsToNullstringOptional

Specifies whether scheduledReacceptance and scheduledDate should be cleared. May be one of:

  • "scheduledReacceptance"
  • "scheduledDate"
  • "scheduledReacceptance,scheduledDate"
isMajorVersionbooleanOptional
Not used.
isSharedbooleanOptional

When true, indicates that the elastic template is shared with one or more users in the account.

namestringOptional
Not used.
requireReacceptancebooleanOptional

When true, requires signers who have previously agreed to this elastic signing agreement to sign again. The major version number is incremented, and the minor version number is set to zero. For example: 2.1 to 3.0

When false, signers who have previously agreed do not need to sign again. Only the minor version number is incremented. For example: 2.1 to 2.2

scheduledDateobjectOptional
The time and date when this elastic template is activated.
scheduledReacceptanceobjectOptional
statusstringOptional

Status of an elastic template. This property is read-only. Possible values:

  • active
  • inactive
  • deleted
transferFromUserIdstringOptional

Not used. To update the user ID of an elastic template, use the updateClickwrap endpoint.

transferToUserIdstringOptional

Not used. To update the user ID of an elastic template, use the updateClickwrap endpoint.

Response

Successful response.
accountIdstringOptional

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

clickwrapIdstringOptional
The GUID of the elastic template.
clickwrapNamestringOptional
The name of the elastic template.
clickwrapVersionIdstringOptional
The unique GUID of this elastic template version.
createdTimeobjectOptional
The time that the elastic template was created.
dataFieldslist of objectsOptional

An array of dataField objects.

lastModifiedobjectOptional
The time that the elastic template was last modified.
lastModifiedBystringOptional
The user GUID of the last user who modified this elastic template.
ownerUserIdstringOptional
The user ID of the owner of this clickwrap.
requireReacceptancebooleanOptional

When true, requires signers who have previously agreed to this elastic signing agreement to sign again. The major version number is incremented, and the minor version number is set to zero. For example: 2.1 to 3.0

When false, signers who have previously agreed do not need to sign again. Only the minor version number is incremented. For example: 2.1 to 2.2

scheduledDateobjectOptional
The time and date when this elastic template is activated.
scheduledReacceptanceobjectOptional
statusstringOptional

Clickwrap status. Possible values:

  • draft
  • active
  • inactive
  • deleted
versionIdstringOptional
The GUID of the version.
versionNumberstringOptional

Human-readable version number. For example 1.2.

Errors

400
Bad Request Error