Themes
Overview
Themes allow you to control the branding of documents and emails sent from your QuicklySign workspace.
If your organisation manages multiple brands or subsidiaries, themes allow you to apply the correct branding to each document without modifying your integration.
Themes are configured directly within the QuicklySign web interface and can then be applied through the API when creating document packs.
🎥 Demo Watch the walkthrough: Using custom branding via the API
Typical Workflow for Using Themes
Using themes via the API usually follows three steps:
- Retrieve the available themes in your workspace
- Select the theme you want to apply
- Apply the theme when creating a document pack
Get Available Themes
To retrieve the themes configured for your workspace, call the themes endpoint.
GET /v1/themes
Authorization: Bearer <ACCESS_TOKEN>This endpoint returns all themes available to your workspace.
Each theme contains:
| Field | Description |
|---|---|
| key | Unique identifier used when applying the theme |
| name | Human-readable name configured in the QuicklySign UI |
Example Response
{
"data": {
"themes": [
{
"key": "Gl2ZXIhCxIUQWNjb3VudEJyYW5kaW5nVGhlbWUYgICgmvzmtwsMogEHc2FuZGJveA",
"name": "Branding Example Theme 1"
},
{
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXISCxIFVGhlbWUiB3NhbmRib3gMogEHc2FuZGJveA",
"name": "Branding Example Theme 2"
}
]
},
"status": {
"status_code": 200
}
}Filtering Themes by Workspace
You can retrieve themes for a specific workspace by passing a workspace identifier as a query parameter.
GET /v1/themes?workspace_key=<workspace_key>Alternatively, the following parameters can also be used:
team_keyaccount_key
These values are interchangeable and will return the same set of themes associated with that workspace.
Example:
GET /v1/themes?team_key=<team_key>Selecting a Theme
From the API response, identify the key of the theme you want to use.
This key uniquely identifies the theme and must be included when creating a document pack.
Only the key is required - the theme name is not used by the API.
Applying a Theme When Creating a Document Pack
To apply a theme, include the branding_key inside the signing_settings object when creating a document pack.
Once applied, QuicklySign automatically applies the selected branding to the document workflow.
Example
{
"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 a Theme Controls
Applying a theme affects the visual branding applied during the signing process.
Emails Sent to Signatories
Themes control the appearance of notification emails, including:
- Logos
- Brand colours
- Headers and footers
- Visual styling around the signing link
Final Signed Documents
Themes can also apply branding to the final signed document, including:
- Logos
- Branding configured in the workspace settings
Notes
Themes only affect visual branding and do not change document logic or signing behaviour.
All document functionality - such as signers, fields, signing order, and automation - remains unchanged.
Updated 3 days ago
