Edit a custom field
post/v1/customField/editThis 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",
)
edit_custom_field_details_request = boldsign.BrandCustomFieldDetails(
fieldName="string",
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)
<?php require_once "vendor/autoload.php";
$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');
$custom_field_api = new BoldSign\Api\CustomFieldApi($config);
$custom_form_field = new \BoldSign\Model\CustomFormField();
$custom_form_field->setFieldType('Signature');
$edit_custom_field_details = new \BoldSign\Model\BrandCustomFieldDetails();
$edit_custom_field_details->setFieldName('string');
$edit_custom_field_details->setBrandId('YOUR_BRAND_ID');
$edit_custom_field_details->setSharedField(true);
$edit_custom_field_details->setFormField($custom_form_field);
$edit_custom_field_details_response = $custom_field_api->editCustomField($custom_field_id='CUSTOM_FIELD_ID', $edit_custom_field_details);
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
CustomFieldApi customFieldApi = new CustomFieldApi();
CustomFormField customFormField = new CustomFormField();
customFormField.setFieldType(CustomFormField.FieldTypeEnum.SIGNATURE);
BrandCustomFieldDetails editBrandCustomFieldDetails = new BrandCustomFieldDetails();
editBrandCustomFieldDetails.setFieldName("string");
editBrandCustomFieldDetails.setBrandId("YOUR_BRAND_ID");
editBrandCustomFieldDetails.setSharedField(true);
editBrandCustomFieldDetails.setFormField(customFormField);
CustomFieldMessage editCustomFieldResponse = customFieldApi.editCustomField("CUSTOM_FIELD_ID", editBrandCustomFieldDetails);
import { CustomFieldApi,BrandCustomFieldDetails, CustomFormField } from "boldsign";
const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");
const formField = new CustomFormField();
formField.fieldType = CustomFormField.FieldTypeEnum.Signature;
formField.placeHolder = "new_placeholder";
const customFieldDetails = new BrandCustomFieldDetails();
customFieldDetails.fieldName = "string";
customFieldDetails.brandId = "YOUR_BRAND_ID";
customFieldDetails.sharedField = true;
customFieldDetails.formField = formField;
const updateCustomFieldResponse = customFieldApi.editCustomField("YOUR_CUSTOMFIELD_ID", customFieldDetails);
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SharedFieldboolean | 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.
|
Example response
200 Success
{
"customFieldId": "e33502d4-xxxx-xxxx-xxxx-6v3n85d51948",
"message": "Custom field edited successfully."
}