Edit Custom Field
POST {{apiBaseUrl}}/v1/customField/edit?customFieldId={{customFieldId}}
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
customFieldId | string | The custom field Id needs to be passed to uniquely identify the custom field. |
Request Body
{"fieldDescription"=>"Modify Custom Field", "brandId"=>"af5dc120-xxxx-xxxx-xxxx-21e3844aa81c", "sharedField"=>true, "formField"=>{"fieldType"=>"Signature", "width"=>125, "height"=>35, "isRequired"=>false, "idPrefix"=>"sign", "restrictIdPrefixChange"=>false}}
RESPONSES
status: OK
{"customFieldId":"e33502d4-xxxx-xxxx-xxxx-6v3n85d51948","message":"Custom field edited successfully."}