Edit a custom field

post/v1/customField/edit

This API allows users to modify the details of a custom field by providing the field ID and the updated field information, such as field name, field description, field order, and form field, ensuring flexibility in custom field management.

Code snippet

curl --location 'https://api.boldsign.com/v1/customField/edit?customFieldId={customFieldId}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json;odata.metadata=minimal;odata.streaming=true' \
--header 'Authorization: {{apiKey}}' \
--data '{
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldOrder": 1,
  "brandId": "string",
  "sharedField": true,
  "formField": {
    "fieldType": "Signature",
    "font": "Courier",
    "width": 60,
    "height": 20,
    "isRequired": true,
    "isReadOnly": true,
    "value": "string",
    "fontSize": 13,
    "fontHexColor": "string",
    "isBoldFont": true,
    "isItalicFont": true,
    "isUnderLineFont": true,
    "lineHeight": 15,
    "characterLimit": 0,
    "placeHolder": "string",
    "validationType": "NumbersOnly",
    "validationCustomRegex": "string",
    "validationCustomRegexMessage": "string",
    "dateFormat": "string",
    "timeFormat": "string",
    "imageInfo": {
      "allowedFileExtensions": "string",
      "title": "string",
      "description": "string"
    },
    "attachmentInfo": {
      "allowedFileTypes": "string",
      "title": "string",
      "description": "string",
      "acceptedFileTypes": [
        "string",
        "string"
      ]
    },
    "editableDateFieldSettings": {
      "dateFormat": "string",
      "minDate": "2023-06-26T05:56:38.655Z",
      "maxDate": "2023-06-26T05:56:38.655Z"
    },
    "hyperlinkText": "string",
    "dataSyncTag": "string",
    "dropdownOptions": [
      "string",
      "string"
    ],
    "textAlign": "Center",
    "textDirection": "LTR",
    "characterSpacing": 0,
    "idPrefix": "string",
    "restrictIdPrefixChange": false,
    "backgroundHexColor": "string"
  }
}'

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, $"https://api.boldsign.com/v1/customField/edit?customFieldId={customFieldId}");
request.Headers.Add("Accept", "application/json;odata.metadata=minimal;odata.streaming=true");
request.Headers.Add("Authorization", "{{apiKey}}");

var content = new StringContent(@"{
    ""fieldName"": ""string"",
    ""fieldDescription"": ""string"",
    ""fieldOrder"": 1,
    ""brandId"": ""string"",
    ""sharedField"": true,
    ""formField"": {
        ""fieldType"": ""Signature"",
        ""font"": ""Courier"",
        ""width"": 60,
        ""height"": 20,
        ""isRequired"": true,
        ""isReadOnly"": true,
        ""value"": ""string"",
        ""fontSize"": 13,
        ""fontHexColor"": ""string"",
        ""isBoldFont"": true,
        ""isItalicFont"": true,
        ""isUnderLineFont"": true,
        ""lineHeight"": 15,
        ""characterLimit"": 0,
        ""placeHolder"": ""string"",
        ""validationType"": ""NumbersOnly"",
        ""validationCustomRegex"": ""string"",
        ""validationCustomRegexMessage"": ""string"",
        ""dateFormat"": ""string"",
        ""timeFormat"": ""string"",
        ""imageInfo"": {
            ""allowedFileExtensions"": ""string"",
            ""title"": ""string"",
            ""description"": ""string""
        },
        ""attachmentInfo"": {
            ""allowedFileTypes"": ""string"",
            ""title"": ""string"",
            ""description"": ""string"",
            ""acceptedFileTypes"": [
                ""string"",
                ""string""
            ]
        },
        ""editableDateFieldSettings"": {
            ""dateFormat"": ""string"",
            ""minDate"": ""2023-06-26T04:11:52.213Z"",
            ""maxDate"": ""2023-06-26T04:11:52.213Z""
        },
        ""hyperlinkText"": ""string"",
        ""dataSyncTag"": ""string"",
        ""dropdownOptions"": [
            ""string"",
            ""string""
        ],
        ""textAlign"": ""Center"",
        ""textDirection"": ""LTR"",
        ""characterSpacing"": 0,
        ""idPrefix"": ""string"",
        ""restrictIdPrefixChange"": false,
        ""backgroundHexColor"": ""string""
    }
}", Encoding.UTF8, "application/json");

request.Content = content;

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

import boldsign

configuration = boldsign.Configuration(
    api_key = "YOUR_API_KEY"
)

with boldsign.ApiClient(configuration) as api_client:
    
    custom_field_api = boldsign.CustomFieldApi(api_client)
    
    custom_form_fields = boldsign.CustomFormField(
        fieldType="Signature",
        width= 60,
        height=60,
        isRequired=True,
        isReadOnly=True,
        value="string",
        lineHeight=15,
        characterLimit=0,
        placeHolder="string",
        validationType="NumbersOnly",
        validationCustomRegex="string",
        validationCustomRegexMessage="string",
        dateFormat="string",
        timeFormat="string",
        imageInfo=boldsign.ImageInfo(
            allowedFileExtensions="string",
            title="string",
            description="string"
        ),
        attachmentInfo=boldsign.AttachmentInfo(
            allowedFileTypes="string",
            title="string",
            description="string",
            acceptedFileTypes=[
                "string",
                "string"
            ]
        ),
        hyperlinkText="string",
        dataSyncTag="string",
        dropdownOptions=[
            "string",
            "string"
        ],
        textAlign="Center",
        textDirection="LTR",
        characterSpacing=0,
        idPrefix="string",
        restrictIdPrefixChange=False,
         backgroundHexColor="string"
    )

    edit_custom_field_details_request = boldsign.BrandCustomFieldDetails(
        fieldName="string",
        fieldDescription="string",
        fieldOrder=1,
        brandId="YOUR_BRAND_ID",
        sharedField=True,
        formField=custom_form_fields
    )
    
    edit_custom_field_details_response = custom_field_api.edit_custom_field(
        custom_field_id="CUSTOM_FIELD_ID",
        brand_custom_field_details=edit_custom_field_details_request
    )

const axios = require('axios');
let data = JSON.stringify({
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldOrder": 1,
  "brandId": "string",
  "sharedField": true,
  "formField": {
    "fieldType": "Signature",
    "font": "Courier",
    "width": 60,
    "height": 20,
    "isRequired": true,
    "isReadOnly": true,
    "value": "string",
    "fontSize": 13,
    "fontHexColor": "string",
    "isBoldFont": true,
    "isItalicFont": true,
    "isUnderLineFont": true,
    "lineHeight": 15,
    "characterLimit": 0,
    "placeHolder": "string",
    "validationType": "NumbersOnly",
    "validationCustomRegex": "string",
    "validationCustomRegexMessage": "string",
    "dateFormat": "string",
    "timeFormat": "string",
    "imageInfo": {
      "allowedFileExtensions": "string",
      "title": "string",
      "description": "string"
    },
    "attachmentInfo": {
      "allowedFileTypes": "string",
      "title": "string",
      "description": "string",
      "acceptedFileTypes": [
        "string",
        "string"
      ]
    },
    "editableDateFieldSettings": {
      "dateFormat": "string",
      "minDate": "2023-06-26T04:11:52.213Z",
      "maxDate": "2023-06-26T04:11:52.213Z"
    },
    "hyperlinkText": "string",
    "dataSyncTag": "string",
    "dropdownOptions": [
      "string",
      "string"
    ],
    "textAlign": "Center",
    "textDirection": "LTR",
    "characterSpacing": 0,
    "idPrefix": "string",
    "restrictIdPrefixChange": false,
    "backgroundHexColor": "string"
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.boldsign.com/v1/customField/edit?customFieldId=string',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json;odata.metadata=minimal;odata.streaming=true', 
    'Authorization': '{{apiKey}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Query parameters

customFieldIdstringRequired

The custom field Id obtained after successful custom field creation needs to be passed to edit the custom field.

Request body

FieldNamestring The name of the custom field you want to create. For example, you can use "My Custom Field" as the field name.

FieldDescriptionstring A brief description or additional information about the custom field.

FieldOrderstring The order or position of the custom field within a list of form fields.

BrandIdstring The unique identifier associated with the brand for which the custom field is being created. This property allows you to associate the custom field specifically with a particular brand within your organization.

SharedFieldstring This property indicates whether the custom field is intended to be shared across users within your organization. If set to true, the field will be accessible and visible to all users in your organization. On the other hand, if set to false, the field will be specific to your individual account and not visible or accessible to other users. Choose true or false based on your specific requirements.

FormFieldobject

The custom form field associated with the brand.

fieldTypestring Type of the form field. The available values are Signature, Initial, CheckBox, TextBox, Label, DateSigned, Image, Attachment, EditableDate, Hyperlink, and Dropdown.

isRequiredboolean Decides whether this form field is required to be filled or not.

valuestring Value to be displayed on the label form field.

fontSizefloat Size of the font.

font string Font family. The values are Courier, Helvetica, and TimesNewRoman.

fontHexColorstring Color of the font. The value should be a hex color code. Example - #035efc.

isBoldFontboolean Decides whether the font should be in bold or not.

isItalicFontboolean Decides whether the font should be in italic or not.

isUnderLineFontboolean Decides whether the font should be underlined or not.

lineHeightinteger Height of a line in the text.

characterLimitinteger Limits the number of characters in the text.

placeHolderstring A hint text to be displayed in the textbox form field by default.

validationTypestring Type of validation for the textbox form field. The values are Only Numbers, Regex, Currency, Email, and None.

validationCustomRegexstring Value for regex validation. This is applicable when the validationType is set to Regex.

validationCustomRegexMessagestring Description for regex validation. This message is displayed when the signer enters an invalid regex format value in the textbox form field.

dateFormatstring Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy.

timeFormatstring Format of the time to be displayed on the date signed form field. The default value is None.

imageInfoobject

Options to customize the image form field.

titlestring	Title of the image form field.
descriptionstring	Description of the image form field.
allowedFileExtensionsstring	Controls the image formats that are allowed to upload on the image form field. The values are `.jpg` or `.jpeg,` `.svg,` `.png,` and `.bmp.`

attachmentInfoobject

Options to customize the attachment form field.

titlestring	Title of the attachment form field.
descriptionstring	Description of the image form field.
allowedFileTypesstring	Controls the file formats that are allowed to upload on the attachment form field. The values are `PDF,` `Document,` and `Image.`

editableDateFieldSettingsobject

Options to customize the editable date form field.

dateFomatstring	Format of the date to be displayed on the date signed form field. The default value is `MM/dd/yyyy`.
minDatestring	The minimum date that can be selected. The string should be in date-time format.
maxDate string	The maximum date that can be selected. The string should be in date-time format.

hyperLinkTextstring Text to be displayed for the hyperlink.

dataSyncTagstring The value that can be specified on two or more textbox form fields to sync them.

dropDownOptionsarray The values that have to be displayed on the dropdown form field. One or more values can be specified.

textAlignstring Determines the horizontal alignment of text for the textbox and label form fields, and can be set to Left, Center, or Right.

textDirectionstring Determines the text direction of text for the textbox and label form fields, and can be set to LTR or RTL.

characterSpacingfloat Determines the character spacing of text for the textbox and label form fields. It can be set as a floating-point value.

idPrefixstring This property holds the initial part of the ID which will be combined with a numerical count.

restrictIdPrefixChangeboolean This boolean property indicates whether the modification of the ID prefix is allowed or not. When set to true, it restricts the sender from altering the ID prefix.

backgroundHexColorstring This property specifies the color that will be used for the background of the label field. The value should be a hex color code. Example - #FFFFFF.

Example response

200 Success

{
  "customFieldId": "e33502d4-xxxx-xxxx-xxxx-6v3n85d51948",
  "message": "Custom field edited successfully."
}