Skip to navigation

Apply custom branding

View as Markdown

The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether the Web Forms API is available for your production account plan.

Web Forms support the use of branding for web form instances and their associated envelopes. Branding enables you to modify the logos and colors displayed in form instances and envelopes. It also enables you to customize envelope behavior. For example, you can set the URL to which users are routed after completing an envelope. Any brand defined in your Docusign account can be applied at the web form configuration level or the web form instance level. See the Docusign account administration Brands guide for details about how to define brands.

Visual customizations

If a brand is applied, web form instances and envelopes display visual customizations in various locations. Expand each section below for an example.

For remote web form instances, which users access via an envelope email, the brand logo and custom colors appear in the email.

Envelope email

The web form instance welcome page displays the logo defined in the brand. The button uses the brand color scheme.

Welcome page

The web form instance form fields page uses the brand color scheme for the progress indicator and buttons.

Web form instance

Before accessing an envelope, users are prompted for consent to use electronic records and signatures. This prompt window uses the brandʼs logo and custom colors.

Electronic signature consent

The envelope uses the brandʼs custom colors for buttons and in other locations.

Envelope

For web form instance flows where a thank you page is displayed, the brand logo appears on that page.

Thank you page

Advanced brand configuration options

If a brand includes advanced configuration options, such as destination URLs to which users are routed after signing an envelope, those settings will be applied to the web form instance flow. See Advanced Configuration for Signing Brands for details about these settings.

Apply a brand to a web form configuration

When you apply a brand to a web form configuration, it will be used for all web form instances created from the configuration, unless the brand is overridden when creating a web form instance. The options to apply a brand to a configuration are:

  • Create a web form configuration from an eSignature template that has a brand selected. See Set Advanced Options for an Envelope or Template for details about selecting a brand for a template. When this option is used, the brand is applied to both web form instances and envelopes. This option is available only for template-based web form configurations.
  • Edit the web form configurationʼs web form template in the Web Forms builder and select Advanced Options to select a brand. See The Signature Page for details about how to access a web form template. Selecting a brand in a web form template affects envelopes only, not web form instances. This option is available only for template-based web form configurations.
  • Edit a web form configuration and select Branding on the Preview tab (shown below) to select a brand. Selecting a brand in the web form configuration affects web form instances, but not envelopes. A brand can be applied in this manner to both standalone and template-based web form configurations.

Web form configuration branding setting

Apply a brand when creating a web form instance

To apply a brand during web form instance creation, include a brandId property in the Instances:createInstance request or an equivalent SDK method call. A brand selected via this method applies to both web form instances and envelopes. A brand specified in the Instances:createInstance request overrides any brand applied at the web form configuration level.

Note: Applying a brand via an API request is not supported for web form instances created from standalone web form configurations.

To obtain a brandʼs ID, you can do either of the following:

  • Send an eSignature API AccountBrands:list request to retrieve details about all brands in your account.
  • Locate the brand on the eSignature Admin Brands page and select Edit. The brand detail page displays the brand ID.

Below is an example request with a brandId.

{
"sendOption": "now",
"brandId": "75f4513d-xxxx-xxxx-xxxx-0c988eeb463c",
"formValues": {
"salary": 121800.55,
"birth_date": "1980-12-18",
"marital_status": "single",
"education": "advanced",
"alerts": ["Funds_withdrawn","Account_info_changed"]
},
"expirationOffset": 720,
"recipients": [
{
"roleName": "signer1",
"name": "Sally Signer",
"email": "sally.signer@email.com"
},
{
"roleName": "signer2",
"name": "Steven Signer",
"email": "steven.signer@email.com"
}
]
}

Next steps