Branding

The branding feature is used to customize the appearance of the email sent to the recipients, such as the logo, background color, and button color. It also allows you to customize the document's signing page with your own logo and enable your own disclaimer.

BoldSign allows you to create multiple brands in your account. While sending the signature request, you can select which brand should be applied for this signature request.

Create brand

post/v1/brand/create

Create a new brand to your organization account. There is no limitation to create number of brands. Also, after the successful brand creation, the API request will return the brand ID. You can use it to set the brand while creating the document.

Code snippet

curl -X POST 'https://api.boldsign.com/v1/brand/create' \
      -H 'X-API-KEY: {your API key}' \
      -F 'brandName=Syncfusion' \
      -F 'brandLogo=@D:\SyncfusionLogo.png' \
      -F 'backgroundColor=red' \
      -F 'buttonColor=green' \
      -F 'buttonTextColor=white' \
      -F 'emailDisplayName={SenderName} from Syncfusion' \
      -F 'redirectUrl=https://www.syncfusion.com/' \
      -F 'isDefault=true' \
      -F 'canHideTagLine=false' \
      -F 'combineAuditTrail=true' \
      -F 'documentTimeZone=+05:30' \
      -F 'emailSignedDocument=1'
var apiClient = new ApiClient("https://api.boldsign.com", " {your API key}");
var brandingClient = new BrandingClient(apiClient);
var brandSettings = new BrandSettings()
{
  BrandName = "Syncfusion",
  BrandLogo = new DocumentFileBytes
  {
      ContentType = "image/png",
      FileName = "D:/SyncfusionLogo.png",
  },
  DocumentTimeZone = "+05:30",
  BackgroundColor = "red",
  ButtonColor = "Green",
  ButtonTextColor = "White",
  EmailDisplayName = "{SenderName} from Syncfusion",
  RedirectUrl = "https://www.syncfusion.com/",
  IsDefault = true,
  CanHideTagLine = false,
  CombineAuditTrail = true,
  EmailSignedDocument = EmailSignedDocument.Attachment
};
BrandingData brandingData = await brandingClient.CreateBrandAsync(createbrand).ConfigureAwait(false);
string brandId = brandingData.BrandId;
import requests

url = "https://api.boldsign.com/v1/brand/create"

payload={'brandName': 'Syncfusion',
'backgroundColor': 'red',
'buttonColor': 'green',
'buttonTextColor': 'white',
'emailDisplayName': '{SenderName} from Syncfusion',
'redirectUrl': 'https://www.syncfusion.com/',
'isDefault': 'true',
'canHideTagLine': 'false',
'combineAuditTrail': 'true',
'documentTimeZone': '+05:30',
'emailSignedDocument': '1'}
files=[
  ('brandLogo',('file',open('{file path}','rb'),'application/octet-stream'))
]
headers = {
  'X-API-KEY': '{your API here}'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)
const axios = require('axios'); 
const FormData = require('form-data'); 
const fs = require('fs'); 
const form = new FormData(); 
form.append('brandName', 'Syncfusion'); 
form.append('brandLogo', fs.readFileSync('D:\\SyncfusionLogo.png'), 'D:\\SyncfusionLogo.png'); 
form.append('backgroundColor', 'red'); 
form.append('buttonColor', 'green'); 
form.append('buttonTextColor', 'white'); 
form.append('emailDisplayName', '{SenderName} from Syncfusion'); 
form.append('redirectUrl', ' https://www.syncfusion.com/'); 
form.append('isDefault', 'true'); 
form.append('canHideTagLine', 'false'); 
form.append('combineAuditTrail', 'true'); 
form.append('documentTimeZone', '+05:30'); 
form.append('emailSignedDocument', '1'); 
const response = await axios.post( 

    ' https://api.boldsign.com/v1/brand/create', 

    form, 
    { 
        headers: { 
            ...form.getHeaders(), 
            'X-API-KEY': '{use your API-KEY here}' 
        } 
    } 
); 

Request body

Heading1Heading2
BrandNamestringRequiredDefine the brand name that is used to set the brand while creating the signature request in the BoldSign application.
BrandLogostringRequiredIt is used to customize the default logo available in the emails and document signing pages. The string should be in binary format.
BackgroundColorstringIt is used to customize the background appearance of the emails sent to the signers.
ButtonColorstringIt is used to customize the button background appearance in emails.
ButtonTextColorstringIt is used to customize the button text color in the email.
EmailDisplayNamestringIt will be used as the From name of emails sent to the signers. You can also define this with placeholder text like {SenderName} from BoldSign. Here, {SenderName} will be replaced with the actual sender name who is making the signature request.
DisclaimerTitlestringYou can set your own legal terms to which signers should agree before signing the document. This property is used to set the title of your legal terms.
DisclaimerDescriptionstringIt is used to set the description of your legal terms.
RedirectUrlstringOnce the signers/reviewers have completed the signing process of the document, it will be redirected to the specified URL.
IsDefaultbooleanIt is used to set the default brand.
CanHideTagLinebooleanIt is used to show/hide the "Powered By BoldSign" option available in the emails sent to the signers. Free plan users can't disable this feature.
CombineAuditTrailbooleanIt is used to combine both signed and audit trial documents as a single document in the completion email.

EmailSignedDocumentstring

It is used to enable/disable the attachments in the final completion email.

The allowed values are,

  1. Attachment - This option allows to attach the signed and audit trail documents to the completion email and also includes a link to download them.
  2. DocumentLink - Displays only the link in the email to download the signed and audit trail documents.
DocumentTimeZonestringIt is used to convert the dates in the audit trail document and date signed field to the specified timezone.

Example response

200 Success

{
  "brandId": "e33502d4-xxxx-xxxx-xxxx-6v3n85d51948"
}