---
title: "Get brand template file"
method: GET
path: "/v2/brands/template-file"
---

# Get brand template file

`GET /v2/brands/template-file`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/brands/template-file`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/brands/template-file/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to download a brand template JSON file with all customizable objects set to SignNow default settings. The file is convenient for saving all the branding settings with one request and for integration purposes. 

The template file is always up-to-date with the latest SignNow branding options.

For a list of available objects, see [About branding](/docs/guides-branding).

Note: data in the brand template file holds SignNow default settings, so you don’t need to create everything from scratch to [create a brand](/docs/general-branding/operations/post-v2-brands-upload-file).

## Response `200`

Correct request: JSON file with the template structure

- object: Brand template with SignNow default values for every brand resource. Edit the values you need and upload the file to create a brand.
  - `title` string: Title of the brand. Replace the default value with your own when you create a brand from the file.
  - `resources` object: Brand resources. Each object holds the SignNow default values for one resource. For what each resource customizes, see [About branding](/docs/guides-branding#what-you-can-customize).
    - `logo` object: Logo resource. Logo for the signing session, completion and authentication pages, embedded sending, and embedded view.
      - `url` string
    - `editor` object: Editor resource. Defines the look of the editor during the signing session and in embedded sending, embedded editor, and embedded view modes, the completion page, and the authentication page.
      - `fields` object: Settings of the fields panel on the left sidebar. Available for embedded sending, embedded editor, and FreeForm invite.
        - `date` object: Configuration of the date field in the fields panel.
          - `visibility` boolean
        - `text` object: Configuration of the text field in the fields panel.
          - `visibility` boolean
        - `email` object: Configuration of the email field in the fields panel.
          - `visibility` boolean
        - `stamp` object: Configuration of the stamp field in the fields panel.
          - `visibility` boolean
        - `formula` object: Configuration of the formula field in the fields panel.
          - `visibility` boolean
        - `checkbox` object: Configuration of the checkbox field in the fields panel.
          - `visibility` boolean
        - `dropdown` object: Configuration of the dropdown field in the fields panel.
          - `visibility` boolean
        - `fullname` object: Configuration of the full name field in the fields panel.
          - `visibility` boolean
        - `initials` object: Configuration of the initials field in the fields panel.
          - `visibility` boolean
        - `hyperlink` object: Configuration of the hyperlink field in the fields panel.
          - `visibility` boolean
        - `signature` object: Configuration of the signature field in the fields panel.
          - `visibility` boolean
        - `attachment` object: Configuration of the attachment field in the fields panel.
          - `visibility` boolean
        - `radiobutton` object: Configuration of the radio button field in the fields panel.
          - `visibility` boolean
      - `sidebar` object: Configuration of the sidebar in the editor.
        - `background` string
        - `visibility` boolean
      - `toolbar` object: Configuration of the toolbar in the header. Available for embedded sending and embedded editor.
        - `background` string
        - `visibility` boolean
      - `settings` object: Settings object that contains attributes for the **More Actions** dropdown button.
        - `visibility` boolean
      - `auth-page` object: Text on the authentication page for invites protected by a password, a phone call, or an SMS.
        - `check-pin` object: Text prompting the signer to enter the password.
          - `phone` object: Text for phone/SMS-protected invites.
            - `body-text` object: Text displayed for phone/SMS-protected invites. Localized in English (`en`), Spanish (`es`), and French (`fr`).
              - …
          - `password` object: Text for password-protected invites.
            - `body-text` object: Text displayed for password-protected invites. Localized in English (`en`), Spanish (`es`), and French (`fr`).
              - …
        - `header-text` object: Header text displayed to the signer on the authentication page. Localized in English (`en`), Spanish (`es`), and French (`fr`).
          - `en` string
          - `es` string
          - `fr` string
        - `request-pin` object: Text with instructions for obtaining a password via voice call or SMS. Displayed only for phone/SMS-protected invites.
          - `body-text` object: Text displayed to the signer with instructions for obtaining a password. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
      - `navigation` object: Navigation object that contains attributes for the navigation elements.
        - `visibility` boolean
      - `sender-info` object: Sender contact details shown to the signer, and their visibility.
        - `visibility` boolean
        - `contact-name` string
        - `contact-email` string
      - `close-button` object: Object that defines the visibility and text for the closing options.
        - `title` object: Text for the closing options in the signing session, embedded sending, and embedded editor modes.
          - `editor` object: Text of the **Save and Close** button in the editor. Available for the embedded editor and embedded sending modes. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
          - `signing` object: Text of the **Save Progress and Finish Later** option during the signing session. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
        - `visibility` boolean
      - `progress-bar` object: Progress bar object that contains attributes for the progress bar elements.
        - `default-color` string
        - `completed-color` string
      - `support-chat` object: Configuration of the support chat in the editor.
        - `visibility` boolean
      - `accessibility` object: Accessibility object that contains attributes for the accessibility button.
        - `color` string
        - `border` string
        - `enabled` boolean
        - `background` string
        - `visibility` boolean
        - `hover-color` string
        - `active-color` string
        - `hover-border` string
        - `active-border` string
        - `hover-background` string
        - `active-background` string
      - `complete-page` object: Page that opens after a document is signed or declined.
        - `decline` object: Text that appears on the page after a signer confirms declining a document.
          - `body-text` object: Body text of the page shown after a signer declines a document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
          - `header-text` object: Header of the page shown after a signer declines a document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
        - `success` object: Text that appears on the page after a signer completes a document.
          - `body-text` object: Body text of the page shown after a signer completes a document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
          - `header-text` object: Header of the page shown after a signer completes a document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
            - `en` string
            - `es` string
            - `fr` string
        - `registration` object: Configuration of the registration option on the completion page.
          - `visibility` boolean
        - `button-download` object: Configuration of the download button on the completion page.
          - `visibility` boolean
        - `button-to-signnow` object: Configuration of the button that takes the signer to SignNow from the completion page.
          - `visibility` boolean
      - `document-name` object: Configuration of the document name. Available for embedded signing, embedded sending (in the editor), embedded editor, FreeForm invite, and embedded view.
        - `visibility` boolean
      - `editing-tools` object: Configuration of the left-side editing tools panel. Available for embedded sending, embedded editor, and FreeForm invite.
        - `background` string
      - `decline-button` object: Configuration of the decline option available to the recipient.
        - `visibility` boolean
      - `default-fields` object: Configuration of the **Default fields** tab. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `field-settings` object: Configuration of the **Element settings** in the right sidebar, where users customize field settings. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `page-dimension` object: Default zoom level of document pages in the editor.
        - `percent` integer
      - `preview-button` object: Configuration of the **Open Preview** button in the toolbar. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `complete-footer` object: Footer shown to the signer after all required fields are completed.
        - `visibility` boolean
        - `custom-text` object: Text of the footer shown after all required fields are completed. Localized in English (`en`), Spanish (`es`), and French (`fr`).
          - `en` string
          - `es` string
          - `fr` string
      - `continue-button` object: Configuration of the **Continue** button. Available for embedded sending.
        - `visibility` boolean
      - `download-button` object: Configuration of the download option for the recipient.
        - `visibility` boolean
      - `request-payment` object: Configuration of the request payment option in the editor. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `signing-settings` object: Settings configured for the signing experience.
        - `guide-signers-only-through-required-fields` boolean
        - `auto-apply-signatures-and-initials-to-document-fields` boolean
      - `manage-recipients` object: Configuration of the **Manage Recipients** link. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `step-progress-bar` object: Configuration of the steps progress bar. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `thumbnails-button` object: Configuration of the **Thumbnails** button in the toolbar. Available for embedded sending and embedded editor.
        - `visibility` boolean
      - `decline-invite-text` object: Message in the pop-up that appears when a signer clicks the **Decline** button. The signer needs to confirm declining the document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
        - `en` string
        - `es` string
        - `fr` string
    - `general` object: General resource. Defines the color scheme, consent text, welcome message, and help center visibility of the signing session, and the color scheme for embedded editor, embedded sending, and embedded view.
      - `icons` object: Icons object that contains attributes for all icons in the resource.
        - `color` string
        - `border` string
        - `background` string
        - `hover-color` string
        - `hover-border` string
        - `hover-background` string
      - `texts` object: Text object that contains attributes for texts in the resource.
        - `color` string
      - `header` object: Header object. Contains attributes for headers.
        - `background` string
      - `buttons` object: Button object that contains `primary`, `secondary`, `default`, and `dropdown` button attributes.
        - `default` object: Default button object.
          - `color` string
          - `border` string
          - `background` string
          - `hover-color` string
          - `active-color` string
          - `hover-border` string
          - `active-border` string
          - `hover-background` string
          - `active-background` string
        - `primary` object: Primary button object.
          - `color` string
          - `border` string
          - `background` string
          - `hover-color` string
          - `active-color` string
          - `hover-border` string
          - `active-border` string
          - `hover-background` string
          - `active-background` string
        - `dropdown` object: Dropdown button object.
          - `color` string
          - `border` string
          - `background` string
          - `hover-color` string
          - `active-color` string
          - `hover-border` string
          - `active-border` string
          - `hover-background` string
          - `active-background` string
        - `secondary` object: Secondary button object.
          - `color` string
          - `border` string
          - `background` string
          - `hover-color` string
          - `active-color` string
          - `hover-border` string
          - `active-border` string
          - `hover-background` string
          - `active-background` string
      - `hyperlink` object: Hyperlink colors for default, hover, and active (clicked) states. Available for embedded sending and embedded editor.
        - `color` string
        - `hover-color` string
        - `active-color` string
      - `help-center` object: Configuration of the help center menu option.
        - `visibility` boolean
      - `consent-text` object: Consent text that appears when a signer opens the document. Localized in English (`en`), Spanish (`es`), and French (`fr`).
        - `en` string
        - `es` string
        - `fr` string
      - `main-background` string
      - `welcome-message` object: Welcome message that appears when a signer opens the document.
        - `body-text` object: Welcome message text. Localized in English (`en`), Spanish (`es`), and French (`fr`).
          - `en` string
          - `es` string
          - `fr` string
        - `visibility` boolean
        - `header-text` object: Text displayed in the welcome message header. Localized in English (`en`), Spanish (`es`), and French (`fr`).
          - `en` string
          - `es` string
          - `fr` string
    - `email-logo` object: Email logo resource. Logo that appears in the emails.
      - `url` string
    - `send-invite` object: Send Invite resource. Defines the **Send Invite** page for the embedded sending experience.
      - `from` object: Configuration of the **From** field.
        - `visibility` boolean
      - `header` object: Configuration of the header.
        - `visibility` boolean
      - `settings` object: Configuration of the settings button (gear icon).
        - `visibility` boolean
      - `cc-recipients` object: Configuration of the CC recipients field.
        - `visibility` boolean
      - `preview-panel` object: Configuration of the preview panel.
        - `background` string
        - `visibility` boolean
      - `settings-panel` object: Configuration of the settings panel.
        - `background` string
      - `request-payment` object: Configuration of the **Add Payment Request** link and **Request a Payment** option.
        - `visibility` boolean
      - `customize-message` object: Configuration of the **Customize Message** button.
        - `visibility` boolean
      - `actions-on-completion` object: Configuration of the **Actions On Completion** advanced options.
        - `visibility` boolean
    - `email-invite` object: Email invite resource. Email text that notifies a signer that they have a pending invite.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
    - `email-general` object: Email general resource. General settings of email notifications.
      - `ccd` object: CCD section of the invite emails.
        - `visibility` boolean
      - `logo` object: Logo object in the email.
        - `position` string
      - `buttons` object: **View Document** button object.
        - `color` string
        - `background` string
      - `sender_email` string
      - `contact_sender` object: Contact sender section of the emails.
        - `visibility` boolean
      - `secondary_buttons` object: **Contact Sender** button object.
        - `color` string
        - `background` string
      - `signnow_references` boolean
      - `hide_download_image` boolean
    - `email-cc-invite` object: CC email for invite resource. Text of CC emails sent with invite emails.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
    - `email-invite-canceled` object: Email canceled resource. Email text that notifies a signer that the sender canceled their invite.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
    - `email-invite-reassign` object: Email reassign resource. Email text that notifies a new signer that an invite to sign was reassigned to them.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
        - `forward_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
        - `forward_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
        - `forward_message` string
    - `email-invite-reminder` object: Email reminder resource. Email text that reminds a signer about a pending invite.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `expiration` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
    - `email-cc-invite-signed` object: CC email FreeForm signed resource. Text of CC emails sent when a FreeForm invite is signed.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
    - `email-invite-completed` object: Email completed resource. Email text that notifies a signer that their invite was completed.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `body_message` string
        - `footer_message` string
    - `email-cc-invite-reassign` object: CC email for reassign resource. Text of CC emails sent with reassign emails.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
    - `email-cc-invite-completed` object: CC email completed resource. Text of CC emails sent when an invite to sign is completed.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
    - `email-cc-invite-step-completed` object: CC email for step completed resource. Text of CC emails sent when a step of an invite is completed.
      - `en` object: English (`en`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `es` object: Spanish (`es`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string
      - `fr` object: French (`fr`) version of the email text.
        - `from` string
        - `subject` string
        - `body_header` string
        - `ccd_message` string
        - `body_message` string
        - `footer_message` string

## Other responses

- `400`: * Wrong, expired, or missing token.

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)