How to Set Date Format for Date Fields

You can apply date format to EditableDate and DateSigned fields to specify the desired format for displaying date values.

Supported date formats

BoldSign API supports a variety of date formats, including:

MM/dd/yyyy
dd/MM/yyyy
dd-MMM-yyyy
MMM-dd-yyyy
MMM dd,yyyy
dd MMM,yyyy
yyyy,MMM dd
yyyy/MM/dd
dd-MM-yyyy
MM-dd-yyyy
yyyy-MM-dd

Applying date format to editable date fields

To apply a date format to the EditableDate fields, use the dateFormat property in the EditableDateFieldSettings object.

Applying date format to date digned fields

To apply a date format to the DateSigned fields, use the dateFormat property.

Default date format

If no format is specified, BoldSign uses the default format from your account settings, which you can manage in your BoldSign Business profile.

Here are example codes you can use to set the date format for date fields:

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/document/send' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'Title="Sample Document"' \
  -F 'Signers={
  "name": "hanky",
  "emailAddress": "[email protected]",
  "signerType": "Signer",
  "signerRole": "Signer",
  "formFields": [
    {
      "id": "DateSigned",
      "name": "DateSigned",
      "fieldType": "DateSigned",
      "pageNumber": 1,
      "bounds": {
        "x": 100,
        "y": 100,
        "width": 125,
        "height": 25
      },
      "isRequired": true,
      "dateFormat": "dd/MM/yyyy"
    },
    {
      "id": "EditableDate",
      "name": "EditableDate",
      "fieldType": "EditableDate",
      "pageNumber": 1,
      "bounds": {
        "x": 100,
        "y": 100,
        "width": 125,
        "height": 25
      },
      "isRequired": true,
      "editableDateFieldSettings": {
        "dateFormat": "dd/MM/yyyy",
        "minDate": "2023-07-01T18:18:08.567Z",
        "maxDate": "2023-07-31T18:18:08.567Z"
        }
    }
  ],
  "locale": "EN"
}' \
  -F 'Files=@{your file}' \

var apiClient = new ApiClient("https://api.boldsign.com", "{Your API key}");
var documentClient = new DocumentClient(apiClient);

var documentFilePath = new DocumentFilePath
{
    ContentType = "application/pdf",
    FilePath = "{Your File path}"
};

var filesToUpload = new List<IDocumentFile>
{
    documentFilePath,
};

var DateSignedField = new DateSignedField(
    isRequired: true,
    pageNumber: 1,
    bounds: new Rectangle(x: 100, y: 100, width: 125, height: 25),
    dateFormat:"dd/MM/yyyy",
    id: "DateSignedField"
    );

var EditableDateField = new FormField(
    id: "EditableDate",
    isRequired: true,
    type: FieldType.EditableDate,
    pageNumber: 1,
    bounds: new Rectangle(x: 200, y: 200, width: 125, height: 25),
    editableDateFieldSettings: new EditableDateFieldSettings(dateFormat:"dd/MM/yyyy"));

var formFieldCollections = new List<FormField>()
{
    DateSignedField,
    EditableDateField
};

var signer = new DocumentSigner(
    signerName: "David",
    signerEmail: "[email protected]",
    formFields: formFieldCollections,
    locale: Locales.EN);

var documentSigners = new List<DocumentSigner>()
{
    signer
};

var sendForSign = new SendForSign()
{
    DisableEmails = true,
    Signers = documentSigners,
    Title = "Sample Document",
    Files = filesToUpload
};
var documentCreated = documentClient.SendDocument(sendForSign);
Console.WriteLine(documentCreated.DocumentId);

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    send_for_sign = boldsign.SendForSign(
        title = "Document SDK API",
        document_title = "SDK Document Test case",
        description = "Testing document from SDK integration test case", 
        files = ["YOUR_FILE_PATH"],
        signers = [
            boldsign.DocumentSigner(
                name = "Hanky",
                emailAddress = "[email protected]",
                signerOrder = 1,
                signerType = "Signer",
                formFields = [
                    boldsign.FormField(
                        name = "DateSigned",
                        fieldType = "DateSigned",
                        font = "Helvetica",
                        pageNumber = 1,
                        isRequired = True,
                        dateFormat = "dd/MM/yyyy",
                        bounds = boldsign.Rectangle(x = 50, y = 50, width = 100, height = 150)
                    ),
                    boldsign.FormField(
                        name = "EditableDate",
                        fieldType = "EditableDate",
                        font = "Helvetica",
                        pageNumber = 1,
                        isRequired = True,
                        bounds = boldsign.Rectangle(x = 100, y = 100, width = 125, height = 25),
                        editableDateFieldSettings = boldsign.EditableDateFieldSettings(
                            dateFormat = "dd/MM/yyyy",
                            minDate = "YOUR_MINDATE",
                            maxDate = "YOUR_MAXDATE"
                        )
                    )
                ],
                privateMessage = "This is private message for signer"
            )
        ]
    )

    document_created = document_api.send_document(send_for_sign)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\{FormField, Rectangle, EditableDateFieldSettings, DocumentSigner, SendForSign, DocumentInfo, FileInfo};

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

$document_api = new DocumentApi($config);

$date_signed_field = new FormField();
$date_signed_field->setName('DateSigned');
$date_signed_field->setFieldType('DateSigned');
$date_signed_field->setPageNumber(1);
$date_signed_field->setFont('Helvetica');
$date_signed_field->setIsRequired(true);
$date_field_bounds = new Rectangle([50, 50, 100, 150]);
$date_signed_field->setBounds($date_field_bounds);
$date_signed_field->setDateFormat('dd/MM/yyyy');

$editable_date_field = new FormField();
$editable_date_field->setName('EditableDate');
$editable_date_field->setFieldType('EditableDate');
$editable_date_field->setPageNumber(1);
$editable_date_field->setFont('Helvetica');
$editable_date_field->setIsRequired(true);
$bounds = new Rectangle([50, 50, 100, 150]);
$editable_date_field->setBounds($bounds);

$editable_date_field_settings = new EditableDateFieldSettings();
$editable_date_field_settings->setDateFormat('dd/MM/yyyy');
$editable_date_field_settings->setMinDate('YOUR_MINDATE');
$editable_date_field_settings->setMaxDate('YOUR_MAXDATE');
$editable_date_field->setEditableDateFieldSettings($editable_date_field_settings);

$document_signer = new DocumentSigner();
$document_signer->setName('Hanky');
$document_signer->setEmailAddress('[email protected]');
$document_signer->setSignerOrder(1);
$document_signer->setSignerType('Signer');
$document_signer->setFormFields([$date_signed_field, $editable_date_field]);
$document_signer->setPrivateMessage('This is private message for signer');

$send_for_sign = new SendForSign();

$documentInfo = new DocumentInfo();
$documentInfo->setTitle('Document SDK API');
$documentInfo->setDescription('Testing document from SDK integration test case');
$send_for_sign->setDocumentInfo([$documentInfo]);

$files = new FileInfo();
$files = 'YOUR_FILE_PATH';
$send_for_sign->setFiles([$files]);

$send_for_sign->setTitle('SDK Document Test case');
$send_for_sign->setSigners([$document_signer]);

$document_created = $document_api->sendDocument($send_for_sign);

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

DocumentApi documentApi = new DocumentApi(client);

FormField dateSignedField = new FormField();
dateSignedField.setName("DateSigned");
dateSignedField.setFieldType(FormField.FieldTypeEnum.DATE_SIGNED);
dateSignedField.setPageNumber(1);
dateSignedField.setFont(FormField.FontEnum.HELVETICA);
dateSignedField.setIsRequired(true);
dateSignedField.setDateFormat("dd/MM/yyyy");
Rectangle dateFieldBounds = new Rectangle().x(100f).y(100f).width(100f).height(50f);
dateSignedField.setBounds(dateFieldBounds);

FormField editableDateField = new FormField();
editableDateField.setName("EditableDate");
editableDateField.setFieldType(FormField.FieldTypeEnum.EDITABLE_DATE);
editableDateField.setPageNumber(1);
editableDateField.setFont(FormField.FontEnum.HELVETICA);
editableDateField.setIsRequired(true);
Rectangle bounds = new Rectangle().x(100f).y(100f).width(100f).height(50f);
editableDateField.setBounds(bounds);

EditableDateFieldSettings editableDateFieldSettings = new EditableDateFieldSettings();
editableDateFieldSettings.setDateFormat("dd/MM/yyyy");
editableDateFieldSettings.setMinDate(OffsetDateTime.parse("YOUR_MINDATE"));
editableDateFieldSettings.setMaxDate(OffsetDateTime.parse("YOUR_MAXDATE")); 
editableDateField.setEditableDateFieldSettings(editableDateFieldSettings);

DocumentSigner signer = new DocumentSigner();
signer.setName("Hanky");
signer.setEmailAddress("[email protected]");
signer.setSignerOrder(1);
signer.setSignerType(DocumentSigner.SignerTypeEnum.SIGNER);
ArrayList<FormField> formFields = new ArrayList<>();
formFields.add(editableDateField);
formFields.add(dateSignedField);
signer.setFormFields(formFields);
signer.setPrivateMessage("This is private message for signer");

SendForSign sendForSign = new SendForSign();

File file = new File("YOUR_FILE_PATH");  
sendForSign.setFiles(Arrays.asList(file));   

sendForSign.setSigners(Arrays.asList(signer));
sendForSign.setTitle("Document SDK API");

DocumentCreated documentCreated = documentApi.sendDocument(sendForSign);

import { DocumentApi, DocumentSigner, DocumentInfo, FormField, Rectangle, SendForSign, EditableDateFieldSettings } from "boldsign"; 
import * as fs from 'fs';

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

const bounds = new Rectangle();
bounds.x = 100;
bounds.y = 50;
bounds.width = 100;
bounds.height = 100;

const dateFieldBounds = new Rectangle();
dateFieldBounds.x = 100;
dateFieldBounds.y = 50;
dateFieldBounds.width = 100;
dateFieldBounds.height = 100;

const dateSignedField = new FormField();
dateSignedField.name = "DateSigned";
dateSignedField.fieldType = FormField.FieldTypeEnum.DateSigned;
dateSignedField.font = FormField.FontEnum.Helvetica;
dateSignedField.pageNumber = 1;
dateSignedField.isRequired = true;
dateSignedField.bounds = dateFieldBounds;
dateSignedField.dateFormat = "dd/MM/yyyy";

const editableDateField = new FormField();
editableDateField.name = "EditableDate";
editableDateField.fieldType = FormField.FieldTypeEnum.EditableDate;
editableDateField.font = FormField.FontEnum.Helvetica;
editableDateField.pageNumber = 1;
editableDateField.isRequired = true;
editableDateField.bounds = bounds;

const editableDateFieldSettings = new EditableDateFieldSettings();
editableDateFieldSettings.dateFormat = "dd/MM/yyyy";
editableDateFieldSettings.minDate = new Date('YOUR_MINDATE');
editableDateFieldSettings.maxDate = new Date('YOUR_MAXDATE');
editableDateField.editableDateFieldSettings = editableDateFieldSettings;

const documentSigner = new DocumentSigner();
documentSigner.name = "David";
documentSigner.emailAddress = "[email protected]";
documentSigner.signerOrder = 1;
documentSigner.signerType = DocumentSigner.SignerTypeEnum.Signer;
documentSigner.formFields = [dateSignedField, editableDateField];
documentSigner.privateMessage = "This is private message for signer";

const files = fs.createReadStream("YOUR_FILE_PATH");

const sendForSign = new SendForSign();

const documentInfo = new DocumentInfo();
documentInfo.title = "SDK Document Test case";
documentInfo.description = "Testing document from SDK integration test case";
sendForSign.documentInfo = [documentInfo];

sendForSign.title = "Document SDK API";
sendForSign.signers = [documentSigner];
sendForSign.files = [files];

const documentCreated = documentApi.sendDocument(sendForSign);

In the above example, set the fieldType as dateSigned or editableDate and dateFormat property to one of the supported date formats. Upon executing the above code, a document will be generated with the specified date format values for the date signed and editable date fields.