How to Hide Standard Fields Using Branding

BoldSign supports hiding standard form fields using branding, allowing you to display custom form fields instead. This article will guide you on how to hide standard form fields using branding via the API.

You can hide the standard form fields by setting ShowBuiltInFormFields as false using branding via API.

Here are a few code examples that demonstrate how to hide standard form fields.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/brand/edit?brandId=8b115d45-0xxc-4d69-axxc-cfdbb308e095' \
  -H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
  -H 'X-API-KEY: {Your API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'ShowBuiltInFormFields=false' \
  -F 'CombineAuditTrail=false' \
  -F 'ShowSharedCustomFields=true' \
  -F 'EmailDisplayName={Your email display name}' \
  -F 'BrandLogo=@{Your file path}' \
  -F 'BrandName={Your brand name}' \
  -F 'IsDefault=false' \
  -F 'CanHideTagLine=true' \
  -F 'AllowCustomFieldCreation=false' \

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    brand_api = boldsign.BrandingApi(api_client)
    brand_api.edit_brand(
        brand_id="YOUR_BRAND_ID",
        brand_name="YOUR_BRAND_NAME",
        show_built_in_form_fields=False,
        allow_custom_field_creation=False,
        show_shared_custom_fields=True,
        email_display_name="[email protected]",
        is_default=False,
        can_hide_tag_line=True,
        combine_audit_trail=False,
        brand_logo="YOUR_FILE_PATH"
    )


<?php Require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\BrandingApi;

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$branding_api = new BrandingApi($config);
$branding_api->editBrand(
    $brand_id = "YOUR_BRAND_ID",
    $brand_name = "UPDATED_BRAND_NAME",
    $brand_logo = 'YOUR_FILE_PATH',
    $background_color = "#000000",
    $button_color = "#000000",
    $email_display_name = null,
    $disclaimer_description = null,
    $disclaimer_title = null,
    $redirect_url = null,
    $is_default = false,
    $can_hide_tag_line = false,
    $combine_audit_trail = false,
    $combine_attachments = false,
    $exclude_audit_trail_from_email = false,
    $email_signed_document = 'Attachment',
    $document_time_zone = null,
    $show_built_in_form_fields = true,
);

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");

BrandingApi brandingApi = new BrandingApi(client);
brandingApi.editBrand(
    "YOUR_BRAND_ID",
    "UPDATED_BRAND_NAME",
    new File("YOUR_FILE_PATH"),
    "BACKGROUND_COLOR",
    "BUTTON_COLOR",
    "BUTTON_TEXT_COLOR",
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    true,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
);

import { BrandingApi } from "boldsign";
import * as fs from 'fs';

const brandingApi = new BrandingApi("https://api.boldsign.com");
brandingApi.setApiKey("YOUR_API_KEY");

brandingApi.editBrand(
    "YOUR_BRAND_ID",
    "UPDATED_BRAND_NAME",
    fs.createReadStream("YOUR_FILE_PATH"),
    "BACKGROUND_COLOR",
    "BUTTON_COLOR",
    "BUTTON_TEXT_COLOR",
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    true
);

After executing the code, you can customize the form fields by hiding the standard form fields and displaying only custom fields to the signers through branding.