Themes

Themes allow you to customise the branding of documents, and emails associated with your workspace. If your organisation supports multiple brands, for example subsidiaries, you can use themes to ensure the correct branding is applied for each document.

Themes are configured directly within the Quicklysign user interface and can then be seamlessly applied via the API. Watch a walk through on how to achieve this here Using custom branding VIA the API

Typical Workflow for Using Themes

1. Get Available Themes

   • To view all available themes in your workspace, call the themes endpoint:

     HTTP

     
     GET {{url}}/themes
     Authorization: Bearer <YOUR_ACESS_TOKEN>

   • Example response:

     JSON

     {
       "data": {
         "themes": [
           {
             "key": "Gl2ZXIhCxIUQWNjb3VudEJyYW5kaW5nVGhlbWUYgICgmvzmtwsMogEHc2FuZGJveA",
             "name": "Branding Example Theme 1"
           },
           {
             "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXISCxIFVGhlbWUiB3NhbmRib3gMogEHc2FuZGJveA",
             "name": "Branding Example Theme 2"
           }
         ]
       },
       "status": {
         "status_code": 200
       }
     }

   • To retrieve the list of themes associated with a given workspace, specify the workspace_key as a parameter.

   • Note: team_key or account_key can also be used in place of workspace_key. They are interchangeable.

2. Select a Theme
   From the API response, identify the key of the theme you want to use. This key uniquely identifies the theme and will be required in the next step.

3. Apply the Theme When Creating a Document
   When creating a new document pack, include the branding key inside the signing_settings object of your request body.

   
   
   JSON

   {
     "document_pack_name": "Example Document Pack",
     "document_type": "document",
     "documents": [
       ...
     ],
     "signatories": [
       ...
     ],
     "signing_settings": {
    		"branding_key": "Gl2ZXIhCxIUQWNjb3VudEJyYW5kaW5nVGhlbWUYgICgmvzmtwsMogEHc2FuZGJveA",
       "attachments_visible_to_all_signers": true,
       "can_use_drawn_signature": true,
       "can_use_one_click_initial": true,
       "can_use_one_click_signature": true,
       "can_use_typed_signature": true,
       "can_use_uploaded_signature": true,
       "in_app_signing_page_url": "",
       "obfuscate_contact_info": false,
       "post_signing_url": "",
       "sequential_signing": true,
       "use_signing_wizard": true,
       "use_two_factor_authentication": true
     },
     ...
   }

   
   

What the Theme Controls

When a theme is applied, it will affect:

• Emails sent to signatories (logos, colors, headers/footers)
• Final signed documents (branding, logos)