module:api/TemplatesApi

module:api/TemplatesApi

new module:api/TemplatesApi(apiClient)

Source:

Constructs a new TemplatesApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

createCustomFields(accountId, templateId, optsOrCallback, callback)

Source:

Creates custom document fields in an existing template document.
Creates custom document fields in an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateCustomFields module:model/TemplateCustomFields
callback module:api/TemplatesApi~createCustomFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

createDocumentFields(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Creates custom document fields in an existing template document.
Creates custom document fields in an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
documentFieldsInformation module:model/DocumentFieldsInformation
callback module:api/TemplatesApi~createDocumentFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentFieldsInformation

createEditView(accountId, templateId, optsOrCallback, callback)

Source:

Provides a URL to start an edit view of the Template UI
This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
returnUrlRequest module:model/ReturnUrlRequest
callback module:api/TemplatesApi~createEditViewCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ViewUrl

createLock(accountId, templateId, optsOrCallback, callback)

Source:

Lock a template.
Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.

Note: Users must have envelope locking capability enabled to use this function (the userSetting property canLockEnvelopes must be set to true for the user).
Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
lockRequest module:model/LockRequest
callback module:api/TemplatesApi~createLockCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/LockInformation

createRecipients(accountId, templateId, optsOrCallback, callback)

Source:

Adds tabs for a recipient.
Adds one or more recipients to a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
resendEnvelope String
templateRecipients module:model/TemplateRecipients
callback module:api/TemplatesApi~createRecipientsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Recipients

createTabs(accountId, templateId, recipientId, optsOrCallback, callback)

Source:

Adds tabs for a recipient.
Adds one or more tabs for a recipient.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
recipientId String

The ID of the recipient being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~createTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

createTemplate(accountId, optsOrCallback, callback)

Source:

Creates an envelope from a template.
Creates a template definition using a multipart request.

###Template Email Subject Merge Fields

Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template.

The merge fields, based on the recipient's role name, are added to the emailSubject property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.

Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient.

Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.

To add a recipient's name in the subject line add the following text in the emailSubject property when creating the template or when sending an envelope from a template:

[[_UserName]]

Example:

"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",

To add a recipient's email address in the subject line add the following text in the emailSubject property when creating the template or when sending an envelope from a template:

[[_Email]]

Example:

"emailSubject":"[[Signer 1_Email]], Please sign this NDA",

In both cases the is the recipient's contents of the roleName property in the template.

For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[_UserName]] or [[_Email]] is shown in the email subject.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
envelopeTemplate module:model/EnvelopeTemplate
callback module:api/TemplatesApi~createTemplateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TemplateSummary

createTemplateDocumentResponsiveHtmlPreview(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Post Responsive HTML Preview for a document in a template.
Creates a preview of the
responsive,
HTML version of a specific template document. This
method enables you to preview a PDF document
conversion to responsive HTML across device types
prior to sending.

The request body is a documentHtmlDefinition
object, which holds the responsive signing
parameters that define how to generate the HTML
version of the signing document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
documentHtmlDefinition module:model/DocumentHtmlDefinition
callback module:api/TemplatesApi~createTemplateDocumentResponsiveHtmlPreviewCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentHtmlDefinitions

createTemplateDocumentTabs(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Adds the tabs to a tempate
Adds tabs to the document specified by documentId in the
template specified by templateId.

In the request body, you only need to specify the tabs that your
are adding. For example, to add a text
prefill tab,
your request body might look like this:

{
  "prefillTabs": {
    "textTabs": [
      {
        "value": "a prefill text tab",
        "pageNumber": "1",
        "documentId": "1",
        "xPosition": 316,
        "yPosition": 97
      }
    ]
  }
}
Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~createTemplateDocumentTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

createTemplateRecipientPreview(accountId, templateId, optsOrCallback, callback)

Source:

Provides a URL to start a recipient view of the Envelope UI
This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.

For more information, see Preview and Send.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
recipientPreviewRequest module:model/RecipientPreviewRequest
callback module:api/TemplatesApi~createTemplateRecipientPreviewCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ViewUrl

createTemplateResponsiveHtmlPreview(accountId, templateId, optsOrCallback, callback)

Source:

Get Responsive HTML Preview for all documents in a template.
Creates a preview of the
responsive,
HTML versions of all of the documents associated
with a template. This method enables you to
preview the PDF document conversions to responsive
HTML across device types prior to sending.

The request body is a documentHtmlDefinition
object, which holds the responsive signing
parameters that define how to generate the HTML
version of the documents.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
documentHtmlDefinition module:model/DocumentHtmlDefinition
callback module:api/TemplatesApi~createTemplateResponsiveHtmlPreviewCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentHtmlDefinitions

deleteCustomFields(accountId, templateId, optsOrCallback, callback)

Source:

Deletes envelope custom fields in a template.
Deletes envelope custom fields in a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateCustomFields module:model/TemplateCustomFields
callback module:api/TemplatesApi~deleteCustomFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

deleteDocumentFields(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Deletes custom document fields from an existing template document.
Deletes custom document fields from an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
documentFieldsInformation module:model/DocumentFieldsInformation
callback module:api/TemplatesApi~deleteDocumentFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentFieldsInformation

deleteDocumentPage(accountId, templateId, documentId, pageNumber, optsOrCallback, callback)

Source:

Deletes a page from a document in an template.
Deletes a page from a document in a template based on the page number.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
pageNumber String

The page number being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
pageRequest module:model/PageRequest
callback module:api/TemplatesApi~deleteDocumentPageCallback

The callback function, accepting three arguments: error, data, response

deleteDocuments(accountId, templateId, optsOrCallback, callback)

Source:

Deletes documents from a template.
Deletes one or more documents from an existing template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
envelopeDefinition module:model/EnvelopeDefinition
callback module:api/TemplatesApi~deleteDocumentsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TemplateDocumentsResult

deleteGroupShare(accountId, templateId, templatePart, optsOrCallback, callback)

Source:

Removes a member group's sharing permissions for a template.
Removes a member group's sharing permissions for a specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
templatePart String

Currently, the only defined part is groups.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
groupInformation module:model/GroupInformation
callback module:api/TemplatesApi~deleteGroupShareCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/GroupInformation

deleteLock(accountId, templateId, optsOrCallback, callback)

Source:

Deletes a template lock.
Deletes the lock from the specified template. The X-DocuSign-Edit header must be included in the request.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
lockRequest module:model/LockRequest
callback module:api/TemplatesApi~deleteLockCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/LockInformation

deleteRecipient(accountId, templateId, recipientId, optsOrCallback, callback)

Source:

Deletes the specified recipient file from a template.
Deletes the specified recipient file from the specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
recipientId String

The ID of the recipient being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateRecipients module:model/TemplateRecipients
callback module:api/TemplatesApi~deleteRecipientCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Recipients

deleteRecipients(accountId, templateId, optsOrCallback, callback)

Source:

Deletes recipients from a template.
Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateRecipients module:model/TemplateRecipients
callback module:api/TemplatesApi~deleteRecipientsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Recipients

deleteTabs(accountId, templateId, recipientId, optsOrCallback, callback)

Source:

Deletes the tabs associated with a recipient in a template.
Deletes one or more tabs associated with a recipient in a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
recipientId String

The ID of the recipient being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~deleteTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

deleteTemplateDocumentTabs(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Deletes tabs from an envelope document
Deletes tabs from the document specified by documentId in the
template specified by templateId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~deleteTemplateDocumentTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

get(accountId, templateId, optsOrCallback, callback)

Source:

Gets a list of templates for a specified account.
Retrieves the definition of the specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
include String
callback module:api/TemplatesApi~getCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/EnvelopeTemplate

getDocument(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Gets PDF documents from a template.
Retrieves one or more PDF documents from the specified template.

You can specify the ID of the document to retrieve or can specify combined to retrieve all documents in the template as one pdf.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
encrypt String
showChanges String
callback module:api/TemplatesApi~getDocumentCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

getDocumentPageImage(accountId, templateId, documentId, pageNumber, optsOrCallback, callback)

Source:

Gets a page image from a template for display.
Retrieves a page image for display from the specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
pageNumber String

The page number being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
dpi String
maxHeight String
maxWidth String
showChanges String
callback module:api/TemplatesApi~getDocumentPageImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

getDocumentTabs(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Returns tabs on the document.
Returns the tabs on the document specified by documentId in the
template specified by templateId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
pageNumbers String
callback module:api/TemplatesApi~getDocumentTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

getLock(accountId, templateId, callback)

Source:

Gets template lock information.
Retrieves general information about the template lock.

If the call is made by the user who has the lock and the request has the same integrator key as original, then the X-DocuSign-Edit header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the X-DocuSign-Edit header.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
callback module:api/TemplatesApi~getLockCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/LockInformation

getNotificationSettings(accountId, templateId, callback)

Source:

Gets template notification information.
Retrieves the envelope notification, reminders and expirations, information for an existing template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
callback module:api/TemplatesApi~getNotificationSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Notification

getPages(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Returns document page image(s) based on input.
Returns images of the pages in a template document for display based on the parameters that you specify.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String
dpi String
maxHeight String
maxWidth String
nocache String
showChanges String
startPosition String
callback module:api/TemplatesApi~getPagesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PageImages

getPageTabs(accountId, templateId, documentId, pageNumber, callback)

Source:

Returns tabs on the specified page.
Returns the tabs from the page specified by pageNumber of the document specified by documentId in the
template specified by templateId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
pageNumber String

The page number being accessed.
callback module:api/TemplatesApi~getPageTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

getTemplateDocumentHtmlDefinitions(accountId, templateId, documentId, callback)

Source:

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
callback module:api/TemplatesApi~getTemplateDocumentHtmlDefinitionsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentHtmlDefinitionOriginals

getTemplateHtmlDefinitions(accountId, templateId, callback)

Source:

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
callback module:api/TemplatesApi~getTemplateHtmlDefinitionsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentHtmlDefinitionOriginals

listCustomFields(accountId, templateId, callback)

Source:

Gets the custom document fields from a template.
Retrieves the custom document field information from an existing template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
callback module:api/TemplatesApi~listCustomFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

listDocumentFields(accountId, templateId, documentId, callback)

Source:

Gets the custom document fields for a an existing template document.
Retrieves the custom document fields for an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
callback module:api/TemplatesApi~listDocumentFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentFieldsInformation

listDocuments(accountId, templateId, optsOrCallback, callback)

Source:

Gets a list of documents associated with a template.
Retrieves a list of documents associated with the specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeTabs String
callback module:api/TemplatesApi~listDocumentsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TemplateDocumentsResult

listRecipients(accountId, templateId, optsOrCallback, callback)

Source:

Gets recipient information from a template.
Retrieves the information for all recipients in the specified template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeAnchorTabLocations String

When set to true and include_tabs is set to true, all tabs with anchor tab properties are included in the response.
includeExtended String

When set to true, the extended properties are included in the response.
includeTabs String

When set to true, the tab information associated with the recipient is included in the response.
callback module:api/TemplatesApi~listRecipientsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Recipients

listTabs(accountId, templateId, recipientId, optsOrCallback, callback)

Source:

Gets the tabs information for a signer or sign-in-person recipient in a template.
Gets the tabs information for a signer or sign-in-person recipient in a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
recipientId String

The ID of the recipient being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeAnchorTabLocations String

When set to true, all tabs with anchor tab properties are included in the response.
includeMetadata String
callback module:api/TemplatesApi~listTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

listTemplates(accountId, optsOrCallback, callback)

Source:

Gets the definition of a template.
Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String

Number of records to return in the cache.
createdFromDate String
createdToDate String
folderIds String

A comma separated list of folder ID GUIDs.
folderTypes String
fromDate String

Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
include String

A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
isDeletedTemplateOnly String
isDownload String
modifiedFromDate String
modifiedToDate String
order String

Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
orderBy String

Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
searchFields String
searchText String

The search text used to search the names of templates.
sharedByMe String

If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
startPosition String

The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
templateIds String
toDate String

End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
usedFromDate String

Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
usedToDate String

End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
userFilter String

Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
userId String
callback module:api/TemplatesApi~listTemplatesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/EnvelopeTemplateResults

rotateDocumentPage(accountId, templateId, documentId, pageNumber, optsOrCallback, callback)

Source:

Rotates page image from a template for display.
Rotates page image from a template for display. The page image can be rotated to the left or right.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
pageNumber String

The page number being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
pageRequest module:model/PageRequest
callback module:api/TemplatesApi~rotateDocumentPageCallback

The callback function, accepting three arguments: error, data, response

update(accountId, templateId, optsOrCallback, callback)

Source:

Updates an existing template.
Updates an existing template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
envelopeTemplate module:model/EnvelopeTemplate
callback module:api/TemplatesApi~updateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TemplateUpdateSummary

updateCustomFields(accountId, templateId, optsOrCallback, callback)

Source:

Updates envelope custom fields in a template.
Updates the custom fields in a template.

Each custom field used in a template must have a unique name.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateCustomFields module:model/TemplateCustomFields
callback module:api/TemplatesApi~updateCustomFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

updateDocument(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Adds a document to a template document.
Adds the specified document to an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
isEnvelopeDefinition String
envelopeDefinition module:model/EnvelopeDefinition
callback module:api/TemplatesApi~updateDocumentCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/EnvelopeDocument

updateDocumentFields(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Updates existing custom document fields in an existing template document.
Updates existing custom document fields in an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
documentFieldsInformation module:model/DocumentFieldsInformation
callback module:api/TemplatesApi~updateDocumentFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DocumentFieldsInformation

updateDocuments(accountId, templateId, optsOrCallback, callback)

Source:

Adds documents to a template document.
Adds one or more documents to an existing template document.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
envelopeDefinition module:model/EnvelopeDefinition
callback module:api/TemplatesApi~updateDocumentsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TemplateDocumentsResult

updateGroupShare(accountId, templateId, templatePart, optsOrCallback, callback)

Source:

Shares a template with a group
Shares a template with the specified members group.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
templatePart String

Currently, the only defined part is groups.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
groupInformation module:model/GroupInformation
callback module:api/TemplatesApi~updateGroupShareCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/GroupInformation

updateLock(accountId, templateId, optsOrCallback, callback)

Source:

Updates a template lock.
Updates the lock duration time or update the lockedByApp property information for the specified template. The user and integrator key must match the user specified by the lockByUser property and integrator key information and the X-DocuSign-Edit header must be included or an error will be generated.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
lockRequest module:model/LockRequest
callback module:api/TemplatesApi~updateLockCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/LockInformation

updateNotificationSettings(accountId, templateId, optsOrCallback, callback)

Source:

Updates the notification structure for an existing template.
Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateNotificationRequest module:model/TemplateNotificationRequest
callback module:api/TemplatesApi~updateNotificationSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Notification

updateRecipients(accountId, templateId, optsOrCallback, callback)

Source:

Updates recipients in a template.
Updates recipients in a template.

You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
resendEnvelope String
templateRecipients module:model/TemplateRecipients
callback module:api/TemplatesApi~updateRecipientsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/RecipientsUpdateSummary

updateTabs(accountId, templateId, recipientId, optsOrCallback, callback)

Source:

Updates the tabs for a recipient.
Updates one or more tabs for a recipient in a template.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
recipientId String

The ID of the recipient being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~updateTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

updateTemplateDocumentTabs(accountId, templateId, documentId, optsOrCallback, callback)

Source:

Updates the tabs for a template
Updates tabs in the document specified by documentId in the
template specified by templateId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
templateId String

The ID of the template being accessed.
documentId String

The ID of the document being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
templateTabs module:model/TemplateTabs
callback module:api/TemplatesApi~updateTemplateDocumentTabsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Tabs

Type Definitions

createCustomFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createCustomFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createDocumentFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createDocumentFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentFieldsInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createEditViewCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createEditView operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ViewUrl

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createLockCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createLock operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/LockInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createRecipientsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createRecipients operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Recipients

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTemplateCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTemplate operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TemplateSummary

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTemplateDocumentResponsiveHtmlPreviewCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTemplateDocumentResponsiveHtmlPreview operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentHtmlDefinitions

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTemplateDocumentTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTemplateDocumentTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTemplateRecipientPreviewCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTemplateRecipientPreview operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ViewUrl

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createTemplateResponsiveHtmlPreviewCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createTemplateResponsiveHtmlPreview operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentHtmlDefinitions

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteCustomFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteCustomFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteDocumentFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteDocumentFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentFieldsInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteDocumentPageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteDocumentPage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteDocumentsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteDocuments operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TemplateDocumentsResult

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteGroupShareCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteGroupShare operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/GroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteLockCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteLock operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/LockInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteRecipientCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteRecipient operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Recipients

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteRecipientsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteRecipients operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Recipients

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteTemplateDocumentTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteTemplateDocumentTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the get operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/EnvelopeTemplate

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getDocumentCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getDocument operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data Object

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getDocumentPageImageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getDocumentPageImage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data Object

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getDocumentTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getDocumentTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getLockCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getLock operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/LockInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotificationSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getNotificationSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Notification

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPagesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPages operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PageImages

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPageTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPageTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getTemplateDocumentHtmlDefinitionsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getTemplateDocumentHtmlDefinitions operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentHtmlDefinitionOriginals

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getTemplateHtmlDefinitionsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getTemplateHtmlDefinitions operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentHtmlDefinitionOriginals

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCustomFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listCustomFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listDocumentFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listDocumentFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentFieldsInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listDocumentsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listDocuments operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TemplateDocumentsResult

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listRecipientsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listRecipients operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Recipients

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listTemplatesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listTemplates operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/EnvelopeTemplateResults

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

rotateDocumentPageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the rotateDocumentPage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the update operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TemplateUpdateSummary

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCustomFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateCustomFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateDocumentCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateDocument operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/EnvelopeDocument

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateDocumentFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateDocumentFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/DocumentFieldsInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateDocumentsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateDocuments operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TemplateDocumentsResult

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateGroupShareCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateGroupShare operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/GroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateLockCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateLock operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/LockInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateNotificationSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateNotificationSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Notification

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateRecipientsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateRecipients operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/RecipientsUpdateSummary

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateTemplateDocumentTabsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateTemplateDocumentTabs operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Tabs

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.