DocuSign: Click schemas
24 DocuSign schemas with complete fields and constraints.
← Click operations · All schemas
Checks if a user has agreed to a clickwrap — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clientUserId | string | Optional | The user ID of the client. |
hostOrigin | string | Optional | The host origin. |
metadata | string | Optional | A customer-defined string you can use in requests. This string will appear in the corresponding response. |
Checks if a user has agreed to a clickwrap — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | 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. |
agreedOn | object | Optional | Date that the client last completed the agreement. This property is null if `agreementUrl` is not null and `status` is not `agreed`. |
agreementId | string | Optional | The agreement ID. |
agreementUrl | string | Optional | When not null, an agreement is required for user specified by `clientUserId`. When missing the user specified by `clientUserId` has already agreed and does not require a new acceptance. Use this URL to render the agreement in a web page. <!-- or redirected to when providing redirect_url as a query paramter. --> |
clickwrapId | string | Optional | The ID of the clickwrap. |
clientUserId | string | Optional | The user ID of the client. |
consumerDisclosureHtml | string | Optional | The customer-branded HTML with the Electronic Record and Signature Disclosure information |
createdOn | object | Optional | The date when the clickwrap was created. May be null. |
declinedOn | object | Optional | The date when the user declined the most recent required agreement. This property is valid only when `status` is `declined`. Otherwise it is null. |
documents | array | Optional | An array of documents. |
documents[] | Model | Each item | Expand Gets a single clickwrap object — response body — documents item |
metadata | string | Optional | A customer-defined string you can use in requests. This string will appear in the corresponding response. |
settings | Model | Optional | Expand Checks if a user has agreed to a clickwrap — response body — settings The display settings for this agreement. |
status | string | Optional | User agreement status. One of: - `created` - `agreed` - `declined` |
version | string | Optional | The human-readable semver version string. |
versionId | string | Optional | The ID of the version. |
versionNumber | JSON | Optional | |
versionNumber (anyOf 1) | integer | Alternative | Version of the clickwrap. Format: int32 |
versionNumber (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Checks if a user has agreed to a clickwrap — response body — settings, Gets a single clickwrap object — response body — documents item
Checks if a user has agreed to a clickwrap — response body — settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about how an agreement is displayed. |
actionButtonAlignment | string | Optional | Position of the Accept button in the agreement. One of - `right` - `left` |
allowClientOnly | boolean | Optional | When **true**, this agreement can be be used in client-only integrations |
allowedHosts | array | Optional | Hosts that can host the clickwrap. It is an error if the clickwrap didn't come from one of these hosts. |
allowedHosts[] | string | Each item | |
brandId | string | Optional | The signing brand ID. |
consentButtonText | string | Optional | Text on the agree button. |
consentText | string | Optional | The text on agree button. |
declineButtonText | string | Optional | The text on the decline button. |
displayName | string | Optional | The display name of the user agreement. |
documentDisplay | string | Optional | Display type: link or document |
downloadable | boolean | Optional | **True** if the agreement is downloadable. |
format | string | Optional | Display format: inline or modal. |
hasDeclineButton | boolean | Optional | **True** if the agreement has a decline checkbox. |
hostOrigin | string | Optional | The host origin. |
mustRead | boolean | Optional | **True** if the user needs to scroll to the end of the document. |
mustView | boolean | Optional | **True** if the user must view the document. |
recordDeclineResponses | boolean | Optional | When **true**, this agreement records decline actions. |
requireAccept | boolean | Optional | **True** if accept is required. |
sendToEmail | boolean | Optional | **True** if send to email is applicable. |
Creates a new clickwrap version — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for working with clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
displaySettings | Model | Optional | Expand Checks if a user has agreed to a clickwrap — response body — settings Display settings for this clickwrap. |
documents | array | Optional | An array of documents. |
documents[] | Model | Each item | Expand Creates a new clickwrap version — request body — body documents item |
fieldsToNull | string | Optional | Specifies whether `scheduledReacceptance` and `scheduledDate` should be cleared. May be one of: - `"scheduledReacceptance"` - `"scheduledDate"` - `"scheduledReacceptance,scheduledDate"` |
isMajorVersion | boolean | Optional | When **true**, the next version created is a major version. When **false** the next version created is minor. |
isShared | boolean | Optional | |
name | string | Optional | Name of the clickwrap. |
requireReacceptance | boolean | Optional | When **true**, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented. |
scheduledDate | object | Optional | The time and date when this clickwrap is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — request body — body scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | object | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
transferFromUserId | string | Optional | The user ID of current owner of the clickwrap. |
transferToUserId | string | Optional | The user ID of the new owner of the clickwrap. |
Referenced models: Checks if a user has agreed to a clickwrap — response body — settings, Creates a new clickwrap version — request body — body scheduled Reacceptance, Creates a new clickwrap version — request body — body documents item
Creates a new clickwrap version — request body — body documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a document. |
documentBase64 | string | Optional | The base64-encoded contents of the document. |
documentHtml | string | Optional | The HTML representation of the document. |
documentName | string | Optional | The name of the document. |
fileExtension | string | Optional | The file extension of the document. |
order | integer | Optional | The order of document layout. Format: int32 |
Creates a new clickwrap version — request body — body scheduled Reacceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recurrenceInterval | integer | Optional | The time between recurrences specified in `recurrenceIntervalType` units. The minimum and maximum values depend on `recurrenceIntervalType`: - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1 Format: int32 |
recurrenceIntervalType | string | Optional | The units of the `recurrenceInterval`. Must be one of: - `days` - `weeks` - `month` - `years` |
startDateTime | object | Optional | The date when the recurrence interval starts. |
Creates a new clickwrap version — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | 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. |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
clickwrapVersionId | string | Optional | The unique version ID, a GUID, of this clickwrap version. |
createdTime | object | Optional | The time that the clickwrap was created. |
lastModified | object | Optional | The time that the clickwrap was last modified. |
lastModifiedBy | string | Optional | The user ID of the last user who modified this clickwrap. |
ownerUserId | string | Optional | The user ID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | When **true**, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented. |
scheduledDate | object | Optional | The time and date when this clickwrap is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — response body — scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
versionId | string | Optional | The ID of the version. |
versionNumber | string | Optional | Version of the clickwrap. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance
Creates a new clickwrap version — response body — scheduled Reacceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recurrenceInterval | JSON | Optional | |
recurrenceInterval (anyOf 1) | integer | Alternative | The time between recurrences specified in `recurrenceIntervalType` units. The minimum and maximum values depend on `recurrenceIntervalType`: - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1 Format: int32 |
recurrenceInterval (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
recurrenceIntervalType | string | Optional | The units of the `recurrenceInterval`. Must be one of: - `days` - `weeks` - `month` - `years` |
startDateTime | object | Optional | The date when the recurrence interval starts. |
Deletes a specific version of a clickwrap — response body — clickwrap Version Id, created Time, deletion Message, deletion Success, last Modified, last Modified By, owner User Id, require Reacceptance, scheduled Date, scheduled Reacceptance, status, version Id, version Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapVersionId | string | Optional | The unique version ID, a GUID, of this clickwrap version. |
createdTime | object | Optional | The time that the clickwrap was created. |
deletionMessage | string | Optional | A message describing the result of deletion request. One of: - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted. |
deletionSuccess | boolean | Optional | **True** if the clickwrap was deleted successfully. **False** otherwise. |
lastModified | object | Optional | The time that the clickwrap was last modified. |
lastModifiedBy | string | Optional | The user ID of the last user who modified this clickwrap. |
ownerUserId | string | Optional | The user ID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | When **true**, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented. |
scheduledDate | object | Optional | The time and date when this clickwrap is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — response body — scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
versionId | string | Optional | The ID of the version. |
versionNumber | string | Optional | Version of the clickwrap. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance
Deletes clickwraps for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwraps | array | Optional | |
clickwraps[] | Model | Each item | Expand Deletes clickwraps for an account — response body — clickwraps item |
Referenced models: Deletes clickwraps for an account — response body — clickwraps item
Deletes clickwraps for an account — response body — clickwraps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
deletionMessage | string | Optional | A message describing the result of deletion request. One of: - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted. |
deletionSuccess | boolean | Optional | **True** if the clickwrap was deleted successfully. **False** otherwise. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
Deletes the versions of a clickwrap — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
versions | array | Optional | An array delete responses. |
versions[] | Model | Each item | Expand Deletes a specific version of a clickwrap — response body — clickwrap Version Id, created Time, deletion Message, deletion Success, last Modified, last Modified By, owner User Id, require Reacceptance, scheduled Date, scheduled Reacceptance, status, version Id, version Number |
Downloads a document at an order within the agreement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a document. |
documentBase64 | string | Optional | The base64-encoded contents of the document. |
documentDisplay | string | Optional | Display type: link or document |
documentHtml | string | Optional | The HTML representation of the document. |
documentName | string | Optional | The name of the document. |
fileExtension | string | Optional | The file extension of the document. |
mustRead | boolean | Optional | **True** if the user needs to scroll to the end of the document. |
mustView | boolean | Optional | Reserved for DocuSign. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | The order of document layout. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get user agreements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
beginCreatedOn | object | Optional | User agreements from this datetime. |
minimumPagesRemaining | JSON | Optional | |
minimumPagesRemaining (anyOf 1) | integer | Alternative | Number of pages remaining in the response. Format: int32 |
minimumPagesRemaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The number of the current page. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageSize | JSON | Optional | |
pageSize (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
pageSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
userAgreements | array | Optional | An array of user agreements. |
userAgreements[] | Model | Each item | Expand Checks if a user has agreed to a clickwrap — response body |
Referenced models: Checks if a user has agreed to a clickwrap — response body
Gets a single clickwrap object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | 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. |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
clickwrapVersionId | string | Optional | The unique version ID, a GUID, of this clickwrap version. |
createdTime | object | Optional | The time that the clickwrap was created. |
displaySettings | Model | Optional | Expand Checks if a user has agreed to a clickwrap — response body — settings Display settings for a clickwrap. |
documents | array | Optional | An array of documents. |
documents[] | Model | Each item | Expand Gets a single clickwrap object — response body — documents item |
lastModified | object | Optional | The time that the clickwrap was last modified. |
lastModifiedBy | string | Optional | The user ID of the last user who modified this clickwrap. |
ownerUserId | string | Optional | The user ID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | When **true**, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented. |
scheduledDate | object | Optional | The time and date when this clickwrap is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — response body — scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
versionId | string | Optional | The ID of the version. |
versionNumber | string | Optional | Version of the clickwrap. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance, Checks if a user has agreed to a clickwrap — response body — settings, Gets a single clickwrap object — response body — documents item
Gets a single clickwrap object — response body — documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a document. |
documentBase64 | string | Optional | The base64-encoded contents of the document. |
documentHtml | string | Optional | The HTML representation of the document. |
documentName | string | Optional | The name of the document. |
fileExtension | string | Optional | The file extension of the document. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | The order of document layout. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Gets all the clickwraps for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwraps | array | Optional | An array of `clickwrapVersionSummaryResponse` objects. |
clickwraps[] | Model | Each item | Expand Creates a new clickwrap version — response body |
minimumPagesRemaining | JSON | Optional | |
minimumPagesRemaining (anyOf 1) | integer | Alternative | Number of pages remaining in the response. Format: int32 |
minimumPagesRemaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The number of the current page. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageSize | JSON | Optional | |
pageSize (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
pageSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Creates a new clickwrap version — response body
Gets all the versions of an elastic template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The results are paginated. Use the following properties to navigate the pages. - `page`: The page number of the current results. - `pageSize`: The number of results in the current page. - `minimumPagesRemaining`: The number of pages that follow this one. |
accountId | string | Optional | The external account number (int) or account ID GUID. |
clickwrapId | string | Optional | The GUID of the elastic template. |
clickwrapName | string | Optional | The name of the elastic template. |
minimumPagesRemaining | JSON | Optional | |
minimumPagesRemaining (anyOf 1) | integer | Alternative | An array of clickwrap versions. Format: int32 |
minimumPagesRemaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The number of the current page. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageSize | JSON | Optional | |
pageSize (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
pageSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
versions | array | Optional | An array of elastic template versions. |
versions[] | Model | Each item | Expand Gets all the versions of an elastic template — response body — versions item |
Referenced models: Gets all the versions of an elastic template — response body — versions item
Gets all the versions of an elastic template — response body — versions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapVersionId | string | Optional | The unique GUID of this elastic template version. |
createdTime | object | Optional | The time that the elastic template was created. |
dataFields | array | Optional | An array of `dataField` objects. |
dataFields[] | Model | Each item | Expand Gets all the versions of an elastic template — response body — versions item data Fields item |
lastModified | object | Optional | The time that the elastic template was last modified. |
lastModifiedBy | string | Optional | The user GUID of the last user who modified this elastic template. |
ownerUserId | string | Optional | The user GUID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | 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` |
scheduledDate | object | Optional | The time and date when this elastic template is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — response body — scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
versionId | string | Optional | The GUID of the version. |
versionNumber | string | Optional | Human-readable version number. For example `1.2`. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance, Gets all the versions of an elastic template — response body — versions item data Fields item
Gets all the versions of an elastic template — response body — versions item data Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a single data field. |
label | string | Optional | The label of the datafield. This is the text that is displayed to the user. |
name | string | Optional | A string used to refer to the field internally. The name must be unique within an elastic template. The following fields are predefined by the API: - `fullName` - `email` - `company` - `title` - `date` |
type | string | Optional | The type of the field. Valid values: - `STRING` - `NUMBER` - `DATE` |
Gets the current version and other information about the Click API — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buildBranch | string | Optional | |
buildBranchDeployedDateTime | string | Optional | |
buildSHA | string | Optional | |
buildVersion | string | Optional | The internal build version information. |
linkedSites | array | Optional | An array of URLs (strings) of related sites. |
linkedSites[] | string | Each item | |
serviceVersions | array | Optional | An array of `serviceVersion` objects. |
serviceVersions[] | Model | Each item | Expand Gets the current version and other information about the Click API — response body — service Versions item |
Referenced models: Gets the current version and other information about the Click API — response body — service Versions item
Gets the current version and other information about the Click API — response body — service Versions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
version | string | Optional | The human-readable semver version string. |
versionUrl | string | Optional | The URL where this version of the API can be found. |
Starts an export of clickwrap agreements for a specified date range — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Data used to start a bulk agreements export. |
fromDate | object | Optional | The earliest date to return agreements from. |
status | string | Optional | User agreement status. One of: - `agreed` - `declined` |
toDate | object | Optional | The latest date to return agreements from. |
Updates the user ID of a clickwrap — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transferFromUserId | string | Optional | ID of the user to transfer from. |
transferToUserId | string | Optional | ID of the user to transfer to. |