Deletes the specified recipient file from the specified template.

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.

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.

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. The URL can only be used once.

To prevent the user from accessing the sending account, set the returnUrl value in the request body.

Information security notice

If the returnUrl value is not set, this method provides full access to the sending account. If the account has administrative privileges, then this method also provides administrator access.

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

Related topics

• How to create a template

Creates one or more template definitions, using a multipart
request for each template.

Templates
help streamline the sending process when you frequently
send the same or similar documents, or send different documents
to the same group of people.

When you create a template, you define placeholder roles. Rather
than specifying a person, you specify a role that regularly
participates in a transaction that uses the template. Then, when
you create or send an envelope based on the template, you assign
actual recipients to the template roles. The recipients
automatically inherit all of the workflow that is defined for
that role in the template, such as the tabs and routing
information.

Template Email Subject Merge Fields

Placeholder roles have associated merge fields that personalize
the email notification that DocuSign sends. For example, the
template automatically personalizes the email message by adding
placeholders for the recipient’s name and email address within
the email subject line, based on the recipient’s role. When the
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 find out
who the recipient is.

Use the following placeholders
to insert a recipient’s name or
email address in the subject line

To insert a recipient’s name into the subject line,
use the [[<roleName>_UserName]] placeholder
in the emailSubject property when you create the
template:

To include a recipient’s name
or email address in the subject line,
use the following placeholders
in the emailSubject property:

• [[<roleName>_UserName]]
• [[<roleName>_Email]]

For example, if the role name is Signer 1,
you might set emailSubject to one of these strings:

• "[[Signer 1_UserName]], Please sign this NDA"
• "[[Signer 1_Email]], Please sign this NDA"

Note: The maximum length of the
subject line is 100 characters,
including any merged text.

Creating multiple templates

To create multiple templates, you provide a zip file of JSON
files. You can also use the Templates::ListTemplates method with
the is_download query parameter to download a zip file
containing your existing templates and use that as a guide. The
API supports both .zip and .gzip file formats as input.

You also need to set the
Content-Length,
Content-Type,
and
Content-Disposition
headers:

Content-Length: 71068
Content-Type: application/zip
Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip

Related topics

• How to create a template

Retrieves the definition of the specified template.

Updates an existing template.

Returns images of the pages in a template document for display based on the parameters that you specify.

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

Retrieves a page image for display from the specified template.

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

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

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

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

Shares a template with the specified members group.

Note: For a newer version of this functionality, see Accounts: Update Shared Access.

Deletes the specified custom user settings for a single user.

If the custom user settings you want to delete are grouped, you
must include the X-DocuSign-User-Settings-Key header
in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of
customer user settings.

If the X-DocuSign-User-Settings-Key header is not included,
only the custom user settings that were added without
a group are deleted.

Retrieves a list of custom user settings for a single user.

Custom settings provide a flexible way to store and retrieve
custom user information that can be used in your own system.

Note: Custom user settings are not the same as user account
settings.

If the custom user settings you want to retrieve are grouped, you
must include the X-DocuSign-User-Settings-Key header
in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of
customer user settings.

If the X-DocuSign-User-Settings-Key header is not included, only the custom
user settings that were added without a group are retrieved.

Adds or updates custom user settings for the specified user.

Note: Custom user settings are not the same as user account
settings.

Custom settings provide a flexible way to store and retrieve
custom user information that you can use in your own system.

Important: There is a limit on the size for all the custom
user settings for a single user. The limit is 4,000 characters,
which includes the XML and JSON structure for the settings.

You can group custom user settings when adding them. Grouping
allows you to retrieve settings that are in a specific group,
instead of retrieving all the user custom settings.

To group custom user settings, include the
X-DocuSign-User-Settings-Key header in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of
customer user settings.

When getting or deleting grouped custom user settings, you must
include the X-DocuSign-User-Settings-Key header information.

Grouping custom user settings is not required and if the X-DocuSign-User-Settings-Key
header information is not included, the custom user settings are
added normally and can be retrieved or deleted without including
the X-DocuSign-User-Settings-Key header.

Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.

The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.

Updates the user’s detail information, profile information, privacy settings, and personal information in the user ID card.

You can also change a user’s name by changing the information in the userDetails property. When changing a user’s name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.

This method retrieves the signature definitions for the user that you specify.

The userId parameter specified in the endpoint must match the authenticated user’s user ID, and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example, encode “Bob Smith” as “Bob%20Smith”.

Adds a user signature image and/or user initials image to the specified user.

The userId property specified in the endpoint must match the authenticated user’s userId and the user must be a member of the account.

The rules and processes associated with this are:

• If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.
• If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.

For each Image part, the Content-Disposition header has a “filename” value that is used to map to the signatureName and/or signatureInitials properties in the JSON to the image.

For example:
Content-Disposition: file; filename="Ron Test20121127083900"

If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.

The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.

If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.

Removes the signature information for the user.

The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Retrieves the structure of a single signature with a known signature name.

The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.

Note: This will also create a default signature for the user when one does not exist.

The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Deletes the specified initials image or signature image for the specified user.

The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.

The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.

The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Closes one or more users in the account,
preventing them from accessing account features.
Users are not permanently deleted.

The request body requires only
the IDs of the users to close:

{
    "users": [
        { "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163" },
        { "userId": "b6c74c52-xxxx-xxxx-xxxx-457a81d88926" },
        { "userId": "464f7988-xxxx-xxxx-xxxx-781ee556ab7a" }
    ]
}

You can use Users:update
to re-open a closed user.

Retrieves the list of users for the specified account.

The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user.

Adds new users to an account.

The body of this request is an array of newUsers objects. For each new user, you must provide at least the userName and email properties. The maximum number of users you can create in one request is 500 users.

The userSettings property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the locale is set to fr.

POST /restapi/v2.1/accounts/{accountId}/users
Content-Type: application/json

{
  "newUsers": [
    {
      "userName": "Claire Horace",
      "email": "claire@example.com"
    },
    {
      "userName": "Tal Mason",
      "email": "talmason@example.com",
      "company": "TeleSel",
      "userSettings": {
        "locale": "fr",
        "canSendEnvelope": true
      }
    }
  ]
}

A successful response is a newUsers array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an errorDetails property that describes what went wrong.

{
  "newUsers": [
    {
      "userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
      "uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
      "email": "claire@example.com",
      "userName": "Claire Horace",
      "createdDateTime": "0001-01-01T08:00:00.0000000Z",
      "errorDetails": {
        "errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT",
        "message": "Username and email combination already exists for this account."
      }
    },
    {
      "userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
      "uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
      "email": "talmason@example.com",
      "userName": "Tal Mason",
      "userStatus": "ActivationSent",
      "createdDateTime": "2020-05-26T23:25:30.7330000Z"
    }
  ]
}

This method updates the information about one or more account users.

Retrieves the user information for the specified user. For example:

{
  "userName": "Tania Morales",
  "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163",
  "userType": "CompanyUser",
  "isAdmin": "False",
  "isNAREnabled": "false",
  "userStatus": "Active",
  "uri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163",
  "email": "examplename42@orobia.net",
  "createdDateTime": "2019-04-01T22:11:56.4570000Z",
  "userAddedToAccountDateTime": "0001-01-01T08:00:00.0000000Z",
  "firstName": "Tania",
  "lastName": "Morales",
  "jobTitle": "",
  "company": "Company",
  "permissionProfileId": "12345678",
  "permissionProfileName": "DocuSign Viewer",
  "userSettings": {. . .},
  "sendActivationOnInvalidLogin": "false",
  "enableConnectForUser": "false",
  "groupList": [. . .],
  "workAddress": {. . .},
  "homeAddress": {. . .},
  "signatureImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image",
  "initialsImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image",
  "defaultAccountId": "f636f297-xxxx-xxxx-xxxx-8e7a14715950"
}

To update user information for a specific user, submit a Users object with updated field values in the request body of this operation.

Deletes the user profile image from the specified user’s profile.

The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.

Retrieves the user profile picture for the specified user.

The userId path parameter must match the authenticated user’s user ID,
and the user must be a member of the specified account.

Updates the user profile image by uploading an image to the user profile.

The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.

Retrieves a list of the account settings and email
notification information for the specified user.

The response returns the account setting
name/value information and the email notification
settings for the specified user. For more
information, see
Users:create.

Updates the account settings list and email notification types for the specified user.

This method deletes one or more files or sub-folders from a workspace folder or root.

Note: To delete items from a workspace, the status of the workspace must be active.

This method returns the contents of a workspace folder, which can include sub-folders and files.

This method adds a file to a workspace.

This method returns a binary version of a file in a workspace.

This method updates the metadata for one or more specific files or folders in a workspace.

This method returns a workspace file as rasterized pages.

Gets information about the Workspaces that have been created.

This method creates a new workspace.

Deletes an existing workspace (logically).