Struct CreateCustomFieldsDTO 

pub struct CreateCustomFieldsDTO {

    pub location_id: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub placeholder: Option<String>,
    pub show_in_forms: bool,
    pub options: Vec<OptionDTO>,
    pub accepted_formats: Option<String>,
    pub data_type: String,
    pub field_key: String,
    pub object_key: String,
    pub max_file_limit: Option<f64>,
    pub allow_custom_option: Option<bool>,
    pub parent_id: String,
}

Available on crate feature custom-fields only.

CreateCustomFieldsDTO from the GoHighLevel OpenAPI spec.

Fields

location_id: String

Location Id Required by the API.

name: Option<String>

Field name

description: Option<String>

Description of the field

placeholder: Option<String>

Placeholder text for the field

show_in_forms: bool

Whether the field should be shown in forms Required by the API.

options: Vec<OptionDTO>

Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)

accepted_formats: Option<String>

Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Allowed values: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all.

data_type: String

Type of field that you are trying to create Allowed values: TEXT, LARGE_TEXT, NUMERICAL, PHONE, MONETORY, CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, DATE, TEXTBOX_LIST, FILE_UPLOAD, RADIO. Required by the API.

field_key: String

Field key. For Custom Object it’s formatted as “custom_object.{objectKey}.{fieldKey}”. “custom_object” is a fixed prefix, “{objectKey}” is your custom object’s identifier, and “{fieldKey}” is the unique field name within that object. Example: “custom_object.pet.name” for a “name” field in a “pet” custom object. Required by the API.

object_key: String

The key for your custom object. This key uniquely identifies the custom object. Example: “custom_object.pet” for a custom object related to pets. Required by the API.

max_file_limit: Option<f64>

Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.

allow_custom_option: Option<bool>

Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.

parent_id: String

ID of the parent folder Required by the API.

Trait Implementations

impl Clone for CreateCustomFieldsDTO

fn clone(&self) -> CreateCustomFieldsDTO

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCustomFieldsDTO

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateCustomFieldsDTO

fn default() -> CreateCustomFieldsDTO

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateCustomFieldsDTO

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateCustomFieldsDTO

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.