Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
clientUserIdstringOptionalThe user ID of the client.
hostOriginstringOptionalThe host origin.
metadatastringOptionalA 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

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalA 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.
agreedOnobjectOptionalDate that the client last completed the agreement.

This property is null if `agreementUrl` is not null and `status` is not `agreed`.
agreementIdstringOptionalThe agreement ID.
agreementUrlstringOptionalWhen 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.
-->
clickwrapIdstringOptionalThe ID of the clickwrap.
clientUserIdstringOptionalThe user ID of the client.
consumerDisclosureHtmlstringOptionalThe customer-branded HTML with the Electronic Record and Signature Disclosure information
createdOnobjectOptionalThe date when the clickwrap was created. May be null.
declinedOnobjectOptionalThe date when the user declined the most recent required agreement.

This property is valid only when `status` is `declined`. Otherwise it is null.
documentsarrayOptionalAn array of documents.
documents[]ModelEach itemExpand Gets a single clickwrap object — response body — documents item
metadatastringOptionalA customer-defined string you can use in requests. This string will appear in the corresponding response.
settingsModelOptionalExpand Checks if a user has agreed to a clickwrap — response body — settings
The display settings for this agreement.
statusstringOptionalUser agreement status. One of:

- `created`
- `agreed`
- `declined`
versionstringOptionalThe human-readable semver version string.
versionIdstringOptionalThe ID of the version.
versionNumberJSONOptional
versionNumber (anyOf 1)integerAlternativeVersion of the clickwrap.
Format: int32
versionNumber (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootInformation about how an agreement is displayed.
actionButtonAlignmentstringOptionalPosition of the Accept button in the agreement. One of

- `right`
- `left`
allowClientOnlybooleanOptionalWhen **true**, this agreement can be be used in client-only integrations
allowedHostsarrayOptionalHosts that can host the clickwrap.

It is an error if the clickwrap didn't come from one of these hosts.
allowedHosts[]stringEach item
brandIdstringOptionalThe signing brand ID.
consentButtonTextstringOptionalText on the agree button.
consentTextstringOptionalThe text on agree button.
declineButtonTextstringOptionalThe text on the decline button.
displayNamestringOptionalThe display name of the user agreement.
documentDisplaystringOptionalDisplay type: link or document
downloadablebooleanOptional**True** if the agreement is downloadable.
formatstringOptionalDisplay format: inline or modal.
hasDeclineButtonbooleanOptional**True** if the agreement has a decline checkbox.
hostOriginstringOptionalThe host origin.
mustReadbooleanOptional**True** if the user needs to scroll to the end of the document.
mustViewbooleanOptional**True** if the user must view the document.
recordDeclineResponsesbooleanOptionalWhen **true**, this agreement records decline actions.
requireAcceptbooleanOptional**True** if accept is required.
sendToEmailbooleanOptional**True** if send to email is applicable.

Creates a new clickwrap version — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for working with clickwrap.
clickwrapNamestringOptionalThe name of the clickwrap.
displaySettingsModelOptionalExpand Checks if a user has agreed to a clickwrap — response body — settings
Display settings for this clickwrap.
documentsarrayOptionalAn array of documents.
documents[]ModelEach itemExpand Creates a new clickwrap version — request body — body documents item
fieldsToNullstringOptionalSpecifies whether `scheduledReacceptance` and `scheduledDate` should be cleared. May be one of:

- `"scheduledReacceptance"`
- `"scheduledDate"`
- `"scheduledReacceptance,scheduledDate"`
isMajorVersionbooleanOptionalWhen **true**, the next version created is a major version. When **false** the next version created is minor.
isSharedbooleanOptional
namestringOptionalName of the clickwrap.
requireReacceptancebooleanOptionalWhen **true**, requires signers who have previously agreed to this
clickwrap to sign again. The version number is incremented.
scheduledDateobjectOptionalThe time and date when this clickwrap is activated.
scheduledReacceptanceModelOptionalExpand Creates a new clickwrap version — request body — body scheduled Reacceptance
Specifies the interval between reacceptances in days, weeks, months, or years.
statusobjectOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`
transferFromUserIdstringOptionalThe user ID of current owner of the clickwrap.
transferToUserIdstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInformation about a document.
documentBase64stringOptionalThe base64-encoded contents of the document.
documentHtmlstringOptionalThe HTML representation of the document.
documentNamestringOptionalThe name of the document.
fileExtensionstringOptionalThe file extension of the document.
orderintegerOptionalThe order of document layout.
Format: int32

Creates a new clickwrap version — request body — body scheduled Reacceptance

FieldTypePresenceDescription and constraints
$objectRoot
recurrenceIntervalintegerOptionalThe 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
recurrenceIntervalTypestringOptionalThe units of the `recurrenceInterval`. Must be one of:

- `days`
- `weeks`
- `month`
- `years`
startDateTimeobjectOptionalThe date when the recurrence interval starts.

Creates a new clickwrap version — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalA 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.
clickwrapIdstringOptionalThe ID of the clickwrap.
clickwrapNamestringOptionalThe name of the clickwrap.
clickwrapVersionIdstringOptionalThe unique version ID, a GUID, of this clickwrap version.
createdTimeobjectOptionalThe time that the clickwrap was created.
lastModifiedobjectOptionalThe time that the clickwrap was last modified.
lastModifiedBystringOptionalThe user ID of the last user who modified this clickwrap.
ownerUserIdstringOptionalThe user ID of the owner of this clickwrap.
requireReacceptancebooleanOptionalWhen **true**, requires signers who have previously agreed to this
clickwrap to sign again. The version number is incremented.
scheduledDateobjectOptionalThe time and date when this clickwrap is activated.
scheduledReacceptanceModelOptionalExpand Creates a new clickwrap version — response body — scheduled Reacceptance
Specifies the interval between reacceptances in days, weeks, months, or years.
statusstringOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`
versionIdstringOptionalThe ID of the version.
versionNumberstringOptionalVersion of the clickwrap.

Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance

Creates a new clickwrap version — response body — scheduled Reacceptance

FieldTypePresenceDescription and constraints
$objectRoot
recurrenceIntervalJSONOptional
recurrenceInterval (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurrenceIntervalTypestringOptionalThe units of the `recurrenceInterval`. Must be one of:

- `days`
- `weeks`
- `month`
- `years`
startDateTimeobjectOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapVersionIdstringOptionalThe unique version ID, a GUID, of this clickwrap version.
createdTimeobjectOptionalThe time that the clickwrap was created.
deletionMessagestringOptionalA 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.
deletionSuccessbooleanOptional**True** if the clickwrap was deleted successfully. **False** otherwise.
lastModifiedobjectOptionalThe time that the clickwrap was last modified.
lastModifiedBystringOptionalThe user ID of the last user who modified this clickwrap.
ownerUserIdstringOptionalThe user ID of the owner of this clickwrap.
requireReacceptancebooleanOptionalWhen **true**, requires signers who have previously agreed to this
clickwrap to sign again. The version number is incremented.
scheduledDateobjectOptionalThe time and date when this clickwrap is activated.
scheduledReacceptanceModelOptionalExpand Creates a new clickwrap version — response body — scheduled Reacceptance
Specifies the interval between reacceptances in days, weeks, months, or years.
statusstringOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`
versionIdstringOptionalThe ID of the version.
versionNumberstringOptionalVersion of the clickwrap.

Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance

Deletes clickwraps for an account — response body

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapsarrayOptional
clickwraps[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapIdstringOptionalThe ID of the clickwrap.
clickwrapNamestringOptionalThe name of the clickwrap.
deletionMessagestringOptionalA 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.
deletionSuccessbooleanOptional**True** if the clickwrap was deleted successfully. **False** otherwise.
statusstringOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`

Deletes the versions of a clickwrap — response body

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapIdstringOptionalThe ID of the clickwrap.
clickwrapNamestringOptionalThe name of the clickwrap.
versionsarrayOptionalAn array delete responses.
versions[]ModelEach itemExpand 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

Referenced models: 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

FieldTypePresenceDescription and constraints
$objectRootInformation about a document.
documentBase64stringOptionalThe base64-encoded contents of the document.
documentDisplaystringOptionalDisplay type: link or document
documentHtmlstringOptionalThe HTML representation of the document.
documentNamestringOptionalThe name of the document.
fileExtensionstringOptionalThe file extension of the document.
mustReadbooleanOptional**True** if the user needs to scroll to the end of the document.
mustViewbooleanOptionalReserved for DocuSign.
orderJSONOptional
order (anyOf 1)integerAlternativeThe order of document layout.
Format: int32
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get user agreements — response body

FieldTypePresenceDescription and constraints
$objectRoot
beginCreatedOnobjectOptionalUser agreements from this datetime.
minimumPagesRemainingJSONOptional
minimumPagesRemaining (anyOf 1)integerAlternativeNumber of pages remaining in the response.
Format: int32
minimumPagesRemaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONOptional
page (anyOf 1)integerAlternativeThe number of the current page.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSizeJSONOptional
pageSize (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
pageSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userAgreementsarrayOptionalAn array of user agreements.
userAgreements[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalA 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.
clickwrapIdstringOptionalThe ID of the clickwrap.
clickwrapNamestringOptionalThe name of the clickwrap.
clickwrapVersionIdstringOptionalThe unique version ID, a GUID, of this clickwrap version.
createdTimeobjectOptionalThe time that the clickwrap was created.
displaySettingsModelOptionalExpand Checks if a user has agreed to a clickwrap — response body — settings
Display settings for a clickwrap.
documentsarrayOptionalAn array of documents.
documents[]ModelEach itemExpand Gets a single clickwrap object — response body — documents item
lastModifiedobjectOptionalThe time that the clickwrap was last modified.
lastModifiedBystringOptionalThe user ID of the last user who modified this clickwrap.
ownerUserIdstringOptionalThe user ID of the owner of this clickwrap.
requireReacceptancebooleanOptionalWhen **true**, requires signers who have previously agreed to this
clickwrap to sign again. The version number is incremented.
scheduledDateobjectOptionalThe time and date when this clickwrap is activated.
scheduledReacceptanceModelOptionalExpand Creates a new clickwrap version — response body — scheduled Reacceptance
Specifies the interval between reacceptances in days, weeks, months, or years.
statusstringOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`
versionIdstringOptionalThe ID of the version.
versionNumberstringOptionalVersion 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

FieldTypePresenceDescription and constraints
$objectRootInformation about a document.
documentBase64stringOptionalThe base64-encoded contents of the document.
documentHtmlstringOptionalThe HTML representation of the document.
documentNamestringOptionalThe name of the document.
fileExtensionstringOptionalThe file extension of the document.
orderJSONOptional
order (anyOf 1)integerAlternativeThe order of document layout.
Format: int32
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Gets all the clickwraps for an account — response body

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapsarrayOptionalAn array of `clickwrapVersionSummaryResponse` objects.
clickwraps[]ModelEach itemExpand Creates a new clickwrap version — response body
minimumPagesRemainingJSONOptional
minimumPagesRemaining (anyOf 1)integerAlternativeNumber of pages remaining in the response.
Format: int32
minimumPagesRemaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONOptional
page (anyOf 1)integerAlternativeThe number of the current page.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSizeJSONOptional
pageSize (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
pageSize (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootThe 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.

accountIdstringOptionalThe external account number (int) or account ID GUID.
clickwrapIdstringOptionalThe GUID of the elastic template.
clickwrapNamestringOptionalThe name of the elastic template.
minimumPagesRemainingJSONOptional
minimumPagesRemaining (anyOf 1)integerAlternativeAn array of clickwrap versions.
Format: int32
minimumPagesRemaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONOptional
page (anyOf 1)integerAlternativeThe number of the current page.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSizeJSONOptional
pageSize (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
pageSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
versionsarrayOptionalAn array of elastic template versions.
versions[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
clickwrapVersionIdstringOptionalThe unique GUID of this elastic template version.
createdTimeobjectOptionalThe time that the elastic template was created.
dataFieldsarrayOptionalAn array of `dataField` objects.
dataFields[]ModelEach itemExpand Gets all the versions of an elastic template — response body — versions item data Fields item
lastModifiedobjectOptionalThe time that the elastic template was last modified.
lastModifiedBystringOptionalThe user GUID of the last user who modified this elastic template.
ownerUserIdstringOptionalThe user GUID of the owner of this clickwrap.
requireReacceptancebooleanOptionalWhen **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`
scheduledDateobjectOptionalThe time and date when this elastic template is activated.
scheduledReacceptanceModelOptionalExpand Creates a new clickwrap version — response body — scheduled Reacceptance
Specifies the interval between reacceptances in days, weeks, months, or years.
statusstringOptionalClickwrap status. Possible values:

- `active`
- `inactive`
- `deleted`
versionIdstringOptionalThe GUID of the version.
versionNumberstringOptionalHuman-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

FieldTypePresenceDescription and constraints
$objectRootDescribes a single data field.
labelstringOptionalThe label of the datafield. This is the text that is displayed to the user.
namestringOptionalA 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`
typestringOptionalThe type of the field. Valid values:

- `STRING`
- `NUMBER`
- `DATE`

Gets the current version and other information about the Click API — response body

FieldTypePresenceDescription and constraints
$objectRoot
buildBranchstringOptional
buildBranchDeployedDateTimestringOptional
buildSHAstringOptional
buildVersionstringOptionalThe internal build version information.
linkedSitesarrayOptionalAn array of URLs (strings) of related sites.
linkedSites[]stringEach item
serviceVersionsarrayOptionalAn array of `serviceVersion` objects.
serviceVersions[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
versionstringOptionalThe human-readable semver version string.
versionUrlstringOptionalThe URL where this version of the API can be found.

Starts an export of clickwrap agreements for a specified date range — request body — body

FieldTypePresenceDescription and constraints
$objectRootData used to start a bulk agreements export.
fromDateobjectOptionalThe earliest date to return agreements from.
statusstringOptionalUser agreement status. One of:

- `agreed`
- `declined`
toDateobjectOptionalThe latest date to return agreements from.

Updates the user ID of a clickwrap — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
transferFromUserIdstringOptionalID of the user to transfer from.
transferToUserIdstringOptionalID of the user to transfer to.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.