Zoho: Fields schemas (part 1)

← Fields operations · All schemas

Create custom fields in a module — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specify the request body for creating custom fields. Maximum of 25 fields can be created in a single call. Additional keys: not allowed
fields	array	Optional	Specify the list of fields to create. Maximum items: 25 Minimum items: 1
fields[]	object	Each item	Specify the field configuration to create. Additional keys: not allowed
fields[]._update_existing_records	boolean	Optional	Specify whether to update existing auto-number records with the new format.
fields[].association_details	object	Optional	Specify the association details configuration. Additional keys: not allowed
fields[].association_details.lookup_field	object	Required within parent	Specify the details of the lookup field. Additional keys: not allowed
fields[].association_details.lookup_field.api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].association_details.lookup_field.id	string	Optional	Id of the resource. Format: int64
fields[].association_details.lookup_field.reference_id	string	Optional	Represents the temporary identifier used to reference a screen within the same wizard request payload. Maximum length: 255 Pattern: \{\{[a-zA-Z0-9]+\}\}
fields[].association_details.related_field	object	Required within parent	Specify the details of the related field. Additional keys: not allowed
fields[].association_details.related_field.api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].association_details.related_field.id	string	Optional	Id of the resource. Format: int64
fields[].auto_number	object	Optional	Specify the configuration for auto number fields. Additional keys: not allowed
fields[].auto_number.prefix	string	Required within parent	Specify the prefix of the starting number. Maximum length: 16
fields[].auto_number.start_number	string	Required within parent	Specify the starting number for the auto number field. Maximum length: 16
fields[].auto_number.suffix	string	Required within parent	Specify the suffix of the starting number. Maximum length: 16
fields[].crypt	JSON	Optional
fields[].crypt (anyOf 1)	object	Alternative	Specify the field encryption configuration. Additional keys: not allowed
fields[].crypt (anyOf 1).mode	string	Required within parent	Specify the encryption: Store value encrypted. decryption: Store value unencrypted (default). One of: encryption, decryption
fields[].crypt (anyOf 2)	boolean	Alternative	Specify whether field encryption is enabled.
fields[].currency	object	Optional	Specify the currency field configuration. Additional keys: not allowed
fields[].currency.precision	string	Required within parent	Specify the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place. Maximum length: 25
fields[].currency.rounding_option	string	Required within parent	Specify how to round currency values. One of: normal, round_off, round_up, round_down Maximum length: 25
fields[].data_type	string	Required within parent	Specify the data type of the field. One of: text, textarea, email, phone, picklist, multiselectpicklist, date, datetime, integer, autonumber, currency, percent, bigint, double, website, boolean, fileupload, imageupload, lookup, userlookup, multiselectlookup, multiuserlookup, formula, rollup_summary, address Maximum length: 50
fields[].decimal_place	number	Optional	Specify the number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive. Format: int32
fields[].default_value	string	Optional	Specify the default value for the picklist field. Maximum length: 25
fields[].enable_colour_code	boolean	Optional	Specify whether colour coding is enabled for the picklist field.
fields[].enable_record_state	boolean	Optional	Specify whether record state is enabled for the picklist field.
fields[].encrypt_case	string	Optional	Specify the permission case for encrypted field. One of: uppercase, lowercase
fields[].external	object	Optional	Specify the external field configuration for third-party app integration. Additional keys: not allowed
fields[].external.show	boolean	Required within parent	Specify whether to display the field in the UI.
fields[].external.type	string	Required within parent	Specify the external field type. 'user' assigns a different ID per user; 'org' assigns a common ID for the organization. One of: user, org, external_lookup Maximum length: 25
fields[].field_label	string	Required within parent	Specify the unique display label of the field. Maximum length: 25
fields[].filterable	boolean	Optional	Specify whether the field can be used in filters.
fields[].formula	object	Optional	Specify the details of the formula field, including the return type and the expression. Additional keys: not allowed
fields[].formula.dynamic	boolean	Optional	Specify whether the formula is Auto Refresh.
fields[].formula.expression	string	Required within parent	Specify the formula expression. Maximum length: 255
fields[].formula.return_type	string	Required within parent	Specify the return type of the formula. One of: double, currency, text, date, datetime, boolean
fields[].formula.stop_compute_conditionally	boolean	Optional	Specify whether to stop computation conditionally.
fields[].formula.stop_compute_expression	string	Optional	Specify the expression that determines when to stop computation. Maximum length: 255
fields[].formula.sub_return_type	string	Optional	Specify the string subtype of the formula return value when the return type is text. One of: small, medium, large Maximum length: 25
fields[].global_picklist	object	Optional	Specify the global picklist configuration. Additional keys: not allowed
fields[].global_picklist.api_name	string	Optional	Specify the API name of the global picklist. Maximum length: 25
fields[].global_picklist.id	string	Required within parent	Specify the ID of the global picklist to associate with this field. Format: int64
fields[].hipaa_compliance_enabled	boolean	Optional	Specify the enable HIPAA compliance for this field.
fields[].history_tracking	object	Optional	Specify the history tracking configuration. Additional keys: not allowed
fields[].history_tracking.duration_configuration	string	Required within parent	Specify the duration for which history is tracked. One of: days, time Maximum length: 25
fields[].history_tracking.followed_fields	array	Required within parent	Specify the list of fields to create. Maximum items: 10
fields[].history_tracking.followed_fields[]	object	Each item	Specify the field to be tracked. Additional keys: not allowed
fields[].history_tracking.followed_fields[].api_name	string	Required within parent	Specify the API name of the field to be tracked. Maximum length: 25
fields[].history_tracking.followed_fields[].id	string	Required within parent	Specify the ID of the field to be tracked. Format: int64
fields[].history_tracking.related_list_name	string	Required within parent	Specify the name of the related list for history tracking. Maximum length: 50
fields[].history_tracking_enabled	boolean	Optional	Specify whether history tracking is enabled for the field.
fields[].length	integer	Optional	Specify the maximum number of characters allowed. Varies by data type. Format: int32 Maximum: 50000 Minimum: 1
fields[].lookup	object	Optional	Specify the lookup field configuration. Additional keys: not allowed
fields[].lookup.display_label	string	Optional	Specify the display label in related list. Maximum length: 25
fields[].lookup.module	object	Required within parent	Specify the module to associate via lookup. Additional keys: not allowed
fields[].lookup.module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].lookup.module.id	string	Optional	Id of the resource. Format: int64
fields[].lookup.query_details	object	Optional	Specify the filter criteria for lookup records. Additional keys: not allowed
fields[].lookup.query_details.criteria	object	Optional	Specify the filter criteria for lookup fields. Additional keys: not allowed
fields[].lookup.query_details.criteria.group	array	Required within parent	Specify the array of filter conditions. Maximum items: 10
fields[].lookup.query_details.criteria.group[]	object	Each item	Specify the group criteria values. Additional keys: not allowed
fields[].lookup.query_details.criteria.group[].comparator	string	Required within parent	Specify the comparison operator. One of: equal, not_equal, like, not_like, greater_equal, greater_than, less_equal, less_than, in, not_in, starts_with, ends_with, contains, not_contains, between, not_between, include_all, include_any, exclude_all, exclude_any
fields[].lookup.query_details.criteria.group[].field	object	Required within parent	Specify the field details. Additional keys: not allowed
fields[].lookup.query_details.criteria.group[].field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].lookup.query_details.criteria.group[].field.id	string	Optional	Id of the resource. Format: int64
fields[].lookup.query_details.criteria.group[].value	JSON	Required within parent	Specify the value to compare against.
fields[].lookup.query_details.criteria.group[].value (anyOf 1)	string	Alternative	Specify the value to be matched. Maximum length: 125
fields[].lookup.query_details.criteria.group[].value (anyOf 2)	array	Alternative	Specify the array list of value to be matched. Maximum items: 10
fields[].lookup.query_details.criteria.group[].value (anyOf 2)[]	string	Each item	Specify the value to be matched. Maximum length: 125
fields[].lookup.query_details.criteria.group_operator	string	Optional	Specify the logical operator for multiple conditions. One of: AND, OR
fields[].lookup.revalidate_filter_during_edit	boolean	Optional	Specify the revalidate filters during record edit. Default: false
fields[].lookup.sharing_properties	object	Optional	Specify the sharing configuration (for userlookup). Additional keys: not allowed
fields[].lookup.sharing_properties.share_permission	string	Required within parent	Specify the sharing permission level. One of: full-access, read-write, read-only
fields[].lookup.sharing_properties.share_preference_enabled	boolean	Required within parent	Specify the enable share preferences.
fields[].lookup.sharing_properties.share_with_superiors	boolean	Optional	Specify the enable share preferences.
fields[].multiselectlookup	object	Optional	Specify the multi-select lookup field configuration. Additional keys: not allowed
fields[].multiselectlookup.connected_details	object	Required within parent	Specify the details of the module to connect. Additional keys: not allowed
fields[].multiselectlookup.connected_details.field	object	Required within parent	Specify the field details. Additional keys: not allowed
fields[].multiselectlookup.connected_details.field.field_label	string	Required within parent	Specify the field label in connected module. Maximum length: 25
fields[].multiselectlookup.connected_details.module	object	Required within parent	Specify the API name of module to connect. Additional keys: not allowed
fields[].multiselectlookup.connected_details.module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].multiselectlookup.connected_details.module.id	string	Optional	Id of the resource. Format: int64
fields[].multiselectlookup.linking_details	object	Required within parent	Specify the linking module details. Additional keys: not allowed
fields[].multiselectlookup.linking_details.module	object	Required within parent	Specify the module name passed as parameter is case insensitive. For example, the module name 'Leads'. Additional keys: not allowed
fields[].multiselectlookup.linking_details.module.plural_label	string	Required within parent	Specify the plural label for linking module. Maximum length: 25
fields[].number_separator	boolean	Optional	Specify whether to display the field value in formatted view. The default value is true.
fields[].pick_list_values	array	Optional	Specify the picklist configuration. Maximum items: 10
fields[].pick_list_values[]	object	Each item	Specify the picklistValue to be shown. Additional keys: not allowed
fields[].pick_list_values[].actual_value	string	Required within parent	Specify the actual value of the picklist option. Once set, this value cannot be changed. Maximum length: 25
fields[].pick_list_values[].colour_code	string	Optional	Specify the hex code for the picklist value color. Maximum length: 25
fields[].pick_list_values[].display_value	string	Required within parent	Specify the display Value to be shown. Maximum length: 25
fields[].pick_list_values[].reference_value	string	Optional	Specify the reference value to be Userd Internal. Maximum length: 25
fields[].pick_list_values_sorted_lexically	boolean	Optional	Specify whether picklist values are sorted lexically.
fields[].private	object	Optional	Specify the gDPR compliance configuration. Additional keys: not allowed
fields[].private.type	string	Required within parent	Specify the privacy level for GDPR compliance. One of: Low, High
fields[].profiles	array	Optional	Each object in the array represents the name and ID of the profile that has access to the field. By default, all organization users will have access to the field. **Possible permission types:** read_write, read_only, and hidden. **read_write:** The user has read and write permissions for the field. **read_only:** The user has only read permission for the field. **hidden:** The field is not visible to the user. Note that it is mandatory to specify a permission type to the profiles in order to access the field. Maximum items: 50
fields[].profiles[]	object	Each item	Specify the profile access and permission configuration. Additional keys: not allowed
fields[].profiles[].id	string	Optional	Id of the resource. Format: int64
fields[].profiles[].permission_type	string	Optional	Specify the permission level for this profile. One of: read_write, read_only, hidden
fields[].reference_id	string	Optional	Represents the temporary identifier used to reference a screen within the same wizard request payload. Maximum length: 255 Pattern: \{\{[a-zA-Z0-9]+\}\}
fields[].rollup_summary	object	Optional	Specify the rollup summary field configuration. Additional keys: not allowed
fields[].rollup_summary.based_on_module	object	Required within parent	Specify the source module for rollup. Additional keys: not allowed
fields[].rollup_summary.based_on_module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.expression	object	Required within parent	Specify the calculation expression. Additional keys: not allowed
fields[].rollup_summary.expression.criteria	object	Optional	Specify the filter criteria for lookup fields. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group	array	Required within parent	Specify the array of filter conditions. Maximum items: 10
fields[].rollup_summary.expression.criteria.group[]	object	Each item	Specify the filter details need to be added for validation action. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group[].comparator	string	Required within parent	Specify the comparison operator. One of: equal, not_equal, like, not_like, greater_equal, greater_than, less_equal, less_than, in, not_in, starts_with, ends_with, contains, not_contains, between, not_between, include_all, include_any, exclude_all, exclude_any Maximum length: 25
fields[].rollup_summary.expression.criteria.group[].field	object	Required within parent	Specify the field to be added in validation. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group[].field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.expression.criteria.group[].field.id	string	Optional	Id of the resource. Format: int64
fields[].rollup_summary.expression.criteria.group[].value	JSON	Required within parent	Specify the value to compare against.
fields[].rollup_summary.expression.criteria.group[].value (anyOf 1)	string	Alternative	Specify the value to be matched. Maximum length: 125
fields[].rollup_summary.expression.criteria.group[].value (anyOf 2)	array	Alternative	Specify the array list of value to be matched. Maximum items: 10
fields[].rollup_summary.expression.criteria.group[].value (anyOf 2)[]	string	Each item	Specify the value to be matched. Maximum length: 125
fields[].rollup_summary.expression.criteria.group_operator	string	Optional	Specify the logical operator for multiple conditions. One of: AND, OR
fields[].rollup_summary.expression.function	string	Required within parent	Specify the aggregation function. One of: SUM, COUNT, AVG, MIN, MAX
fields[].rollup_summary.expression.function_parameters	array	Required within parent	Specify the fields to aggregate. Maximum items: 10
fields[].rollup_summary.expression.function_parameters[]	object	Each item	Specify the expression for the calculation need to be done. Additional keys: not allowed
fields[].rollup_summary.expression.function_parameters[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.related_list	object	Required within parent	Specify the related list for rollup. Additional keys: not allowed
fields[].rollup_summary.related_list.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.return_type	string	Required within parent	Specify the return type of the rollup summary. One of: currency, double, integer
fields[].separator	boolean	Optional	Specify whether to use a thousands separator for number fields.
fields[].textarea	object	Optional	Specify the text area field configuration. Additional keys: not allowed
fields[].textarea.type	string	Required within parent	Specify the small: 2000 chars, large: 32000 chars, rich_text: 50000 chars. One of: small, large, rich_text
fields[].tooltip	object	Optional	Represents the tooltip content for the field. **Possible names**: **static_text** : Specifies that the field should have a static text tooltip. The tooltip content will be displayed in the field when the user clicks on the field box. **info_icon** : Specifies that the field should have an info icon tooltip. Clicking on the "info icon" will display the tooltip contents. Note that it is mandatory to specify both the name and value when you specify tooltip key. Additional keys: not allowed
fields[].tooltip.name	string	Required within parent	Specify the type of tooltip: static_text (shown in field box) or info_icon (shown on icon click). One of: static_text, info_icon
fields[].tooltip.value	string	Required within parent	Specify the tooltip content. Max 35 chars for static_text, 255 chars for info_icon. Maximum length: 255
fields[].unique	JSON	Optional
fields[].unique (anyOf 1)	object	Alternative	Specify the field uniqueness configuration. Additional keys: not allowed
fields[].unique (anyOf 1).case_sensitive	boolean	Required within parent	Specify whether uniqueness is case sensitive.
fields[].unique (anyOf 2)	boolean	Alternative	Specify whether the field value must be unique across records.
fields[] (allOf 1)	JSON	All variants apply
fields[] (allOf 2)	JSON	All variants apply
fields[] (allOf 3)	JSON	All variants apply
fields[] (allOf 4)	JSON	All variants apply
fields[] (allOf 5)	JSON	All variants apply
fields[] (allOf 6)	JSON	All variants apply
fields[] (allOf 7)	JSON	All variants apply
fields[] (allOf 8)	JSON	All variants apply
fields[] (allOf 9)	JSON	All variants apply
fields[] (allOf 10)	JSON	All variants apply
fields[] (allOf 11)	JSON	All variants apply
fields[] (allOf 12)	JSON	All variants apply
fields[] (allOf 13)	JSON	All variants apply
fields[] (allOf 14)	JSON	All variants apply
fields[] (allOf 15)	JSON	All variants apply
fields[] (allOf 16)	JSON	All variants apply
fields[] (allOf 17)	JSON	All variants apply
fields[] (allOf 18)	JSON	All variants apply
fields[] (allOf 19)	JSON	All variants apply
fields[] (allOf 20)	JSON	All variants apply
fields[] (allOf 21)	JSON	All variants apply
fields[] (allOf 22)	JSON	All variants apply
fields[] (allOf 23)	JSON	All variants apply
fields[] (allOf 24)	JSON	All variants apply
fields[] (allOf 25)	JSON	All variants apply

Delete a custom field — response body — fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a single field creation. Additional keys: not allowed
code	string	Required within parent	Represents the result code. Known values: SUCCESS
details	object	Required within parent	Represents the details of the created field. Additional keys: not allowed
details.id	string	Required within parent	Represents the ID of the created field. Maximum length: 25
message	string	Required within parent	Represents the result message. Maximum length: 225
status	string	Required within parent	Represents the status of the operation. Known values: success

Get field metadata by ID — response body — fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the schema representing a field in the module. Additional keys: not allowed
additional_column	JSON	Optional
additional_column (anyOf 1)	string	Alternative	Represents the additional column of the field. Maximum length: 100
additional_column (anyOf 2)	null	Alternative	Represents the null if no information is available.
address	JSON	Optional
address (anyOf 1)	object	Alternative	Represents the address details, if available. Additional keys: not allowed
address (anyOf 1).type	string	Required within parent	Represents the type of address. Maximum length: 25
address (anyOf 2)	null	Alternative	Represents the null if no information is available.
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
associated_module	JSON	Optional
associated_module (anyOf 1)	object	Alternative	Represents the details of the associated module, such as a subform. Additional keys: not allowed
associated_module (anyOf 1).id	string	Required within parent	Id of the resource. Format: int64
associated_module (anyOf 1).module	string	Required within parent	Represents the name of the module. Maximum length: 100
associated_module (anyOf 2)	null	Alternative	Represents the null if no information is available.
association_details	JSON	Required within parent
association_details (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item association details lookup field, related field
association_details (anyOf 2)	null	Alternative	Represents the null if no information is available.
auto_number	JSON	Required within parent
auto_number (anyOf 1)	object	Alternative	Represents the auto number details of the field. Additional keys: not allowed
auto_number (anyOf 1).prefix	JSON	Optional
auto_number (anyOf 1).prefix (anyOf 1)	string	Alternative	Represents the prefix for the auto number. Maximum length: 25
auto_number (anyOf 1).prefix (anyOf 2)	null	Alternative	Represents the null if no information is available.
auto_number (anyOf 1).start_number	JSON	Optional
auto_number (anyOf 1).start_number (anyOf 1)	number	Alternative	Represents the starting number for the auto number. Format: int32
auto_number (anyOf 1).start_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_number (anyOf 1).starting_number_length	JSON	Optional
auto_number (anyOf 1).starting_number_length (anyOf 1)	number	Alternative	Represents the length of the starting number. Format: int32
auto_number (anyOf 1).starting_number_length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_number (anyOf 1).suffix	JSON	Optional
auto_number (anyOf 1).suffix (anyOf 1)	string	Alternative	Represents the suffix for the auto number. Maximum length: 25
auto_number (anyOf 1).suffix (anyOf 2)	null	Alternative	Represents the null if no information is available.
auto_number (anyOf 2)	null	Alternative	Represents the null if no information is available.
blueprint_supported	boolean	Optional	Indicates whether the field is supported in Blueprint configurations.
businesscard_supported	boolean	Required within parent	Indicates whether the field can be added to the business card section.
child_fields	JSON	Optional
child_fields (anyOf 1)	array	Alternative	Represents the list of child fields associated with the Address field. Maximum items: 100
child_fields (anyOf 1)[]	object	Each item	Represents the details of a child Address fields. Additional keys: not allowed
child_fields (anyOf 1)[].field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item child fields array item field
child_fields (anyOf 1)[].sequence_number	JSON	Required within parent
child_fields (anyOf 1)[].sequence_number (anyOf 1)	number	Alternative	Represents the sequence number of the child field present in the Address field. Format: int32
child_fields (anyOf 1)[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
child_fields (anyOf 2)	null	Alternative	Represents the null if no information is available.
colour_code_enabled_by_system	boolean	Required within parent	Indicates whether colour coding is enabled for this field by the system.
column_name	string	Optional	Represents the column name of the field. Maximum length: 100
convert_mapping	Model	Optional	Expand Get field metadata by ID — response body — fields item convert mapping
created_source	string	Required within parent	Represents the source from which the field was created. Maximum length: 60
created_time	JSON	Optional
created_time (anyOf 1)	string	Alternative	Represents the time when the record was created. Format: date-time
created_time (anyOf 2)	null	Alternative	Represents the null if no information is available.
crypt	JSON	Optional
crypt (anyOf 1)	object	Alternative	Represents the encryption configuration of the field when encryption is enabled. Additional keys: not allowed
crypt (anyOf 1).encrypt_case	JSON	Optional
crypt (anyOf 1).encrypt_case (anyOf 1)	string	Alternative	Represents the details of the encryption case. Maximum length: 25
crypt (anyOf 1).encrypt_case (anyOf 2)	null	Alternative	Represents the null if no information is available.
crypt (anyOf 1).mode	string	Required within parent	Represents the encryption mode used. Maximum length: 25
crypt (anyOf 1).status	JSON	Required within parent
crypt (anyOf 1).status (anyOf 1)	number	Alternative	Represents the status of the encryption. Format: int32
crypt (anyOf 1).status (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
crypt (anyOf 2)	null	Alternative	Represents the null if no information is available.
currency	JSON	Required within parent
currency (anyOf 1)	object	Alternative	Represents the currency configuration of the field, including precision, rounding option, and currency code. Additional keys: not allowed
currency (anyOf 1).precision	JSON	Optional
currency (anyOf 1).precision (anyOf 1)	number	Alternative	Represents the precision of the currency. Format: int32
currency (anyOf 1).precision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency (anyOf 1).rounding_option	string	Optional	Represents the rounding option for the currency. Maximum length: 25
currency (anyOf 2)	null	Alternative	Represents the null if no information is available.
custom_field	boolean	Required within parent	Indicates if the field is a custom field.
customizable_properties	JSON	Optional
customizable_properties (anyOf 1)	array	Alternative	Represents the customizable properties of the field. Maximum items: 100
customizable_properties (anyOf 1)[]	string	Each item	Represents a customizable property of the field. Maximum length: 50
customizable_properties (anyOf 2)	null	Alternative	Represents the null if no information is available.
data_type	string	Required within parent	Represents the data type of the field. Maximum length: 25
decimal_place	JSON	Optional
decimal_place (anyOf 1)	JSON	Alternative
decimal_place (anyOf 1) (anyOf 1)	number	Alternative	Represents the number of decimal places for the field. Format: int32
decimal_place (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
decimal_place (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_field	boolean	Required within parent	Indicates if the field is a display field.
display_format	JSON	Optional
display_format (anyOf 1)	string	Alternative	Represents the display format applied to the field value, such as the date or date-time pattern shown in the user interface. Maximum length: 50
display_format (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_format_properties	JSON	Optional
display_format_properties (anyOf 1)	object	Alternative	Represents the display format configuration for the field, including the phone-number split value and radio-button display type. Additional keys: not allowed
display_format_properties (anyOf 1).radio_display_type	string	Optional	Represents the display type applied to radio button fields, such as **all** or **vertical**. Maximum length: 25
display_format_properties (anyOf 1).split	JSON	Optional
display_format_properties (anyOf 1).split (anyOf 1)	number	Alternative	Represents the split value applied to phone number fields, which divides the number into the specified number of segments. Format: int32
display_format_properties (anyOf 1).split (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
display_format_properties (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_label	string	Required within parent	Represents the display label of the field. Maximum length: 50
display_type	JSON	Required within parent
display_type (anyOf 1)	number	Alternative	Represents the display type of the field. Format: int32
display_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email_parser	object	Required within parent	Represents the email parser details of the field. Additional keys: not allowed
email_parser.fields_update_supported	boolean	Required within parent	Indicates if field updates are supported by email parser.
email_parser.record_operations_supported	boolean	Required within parent	Indicates if record operations are supported by email parser.
enable_colour_code	boolean	Required within parent	Indicates if colour code is enabled for the field.
enable_record_category	boolean	Optional	Indicates if the record category feature is enabled for this picklist field. Only returned when the record category feature is available.
enable_transition_for_record_category	boolean	Optional	Indicates if transitions between record categories are enabled. Only returned when enable_record_category is true.
external	JSON	Required within parent
external (anyOf 1)	object	Alternative	Represents the external field configuration of the field, including its visibility and type when integrated with an external system. Additional keys: not allowed
external (anyOf 1).show	boolean	Required within parent	Indicates if the external field is shown.
external (anyOf 1).type	string	Required within parent	Indicates the type of the external field. Maximum length: 50
external (anyOf 2)	null	Alternative	Represents the null if no information is available.
field_label	string	Required within parent	Represents the display name of the field in the user's preferred language. Maximum length: 100
field_read_only	boolean	Required within parent	Indicates whether the field is always read-only and cannot be edited under any circumstances.
filterable	boolean	Required within parent	Indicates if the field is filterable.
formula	JSON	Required within parent
formula (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item formula Represents the formula details of the field
formula (anyOf 2)	null	Alternative	Represents the null if no information is available.
global_picklist	JSON	Optional
global_picklist (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item global picklist api name, id
global_picklist (anyOf 2)	null	Alternative	Represents the null if no information is available.
hipaa_compliance	JSON	Optional
hipaa_compliance (anyOf 1)	object	Alternative	Represents the HIPAA compliance configuration of the field, including restrictions applied during access and export. Additional keys: not allowed
hipaa_compliance (anyOf 1).restricted	boolean	Required within parent	Indicates if the field is restricted.
hipaa_compliance (anyOf 1).restricted_in_export	boolean	Required within parent	Indicates if the field is restricted in export.
hipaa_compliance (anyOf 2)	null	Alternative	Represents the null if no information is available.
hipaa_compliance_enabled	boolean	Optional	Indicates if HIPAA compliance is enabled for the field.
history_tracking	JSON	Optional
history_tracking (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item history tracking duration configuration, duration configured field, followed fields, module, related list name
history_tracking (anyOf 2)	null	Alternative	Represents the null if no information is available.
history_tracking_enabled	boolean	Required within parent	Indicates if history tracking is enabled for the field.
id	string	Required within parent	Id of the resource. Format: int64
json_type	string	Optional	Represents the jSON type of the field. Maximum length: 25
layout_associations	array	Optional	Represents the list of layout associations for the field. Maximum items: 100
layout_associations[]	object	Each item	Represents the layout association details. Additional keys: not allowed
layout_associations[].api_name	string	Required within parent	Represents the API name of the layout. Maximum length: 25
layout_associations[].id	string	Required within parent	Id of the resource. Format: int64
layout_associations[].name	string	Required within parent	Represents the name of the layout. Maximum length: 25
length	JSON	Optional
length (anyOf 1)	number	Alternative	Represents the length of the field. Format: int32
length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lookup	JSON	Required within parent
lookup (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item lookup Represents the lookup field details
lookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
mask_details	JSON	Optional
mask_details (anyOf 1)	object	Alternative	If field masking is enabled for the field, it will return the masking information; otherwise null. Additional keys: allowed
mask_details (anyOf 2)	null	Alternative	Represents the null if no information is available.
mass_update	boolean	Required within parent	Indicates if mass update is enabled for the field.
modified_time	JSON	Optional
modified_time (anyOf 1)	string	Alternative	Represents the time when the record was last modified. Format: date-time
modified_time (anyOf 2)	null	Alternative	Represents the null if no information is available.
multi_module_lookup	JSON	Required within parent
multi_module_lookup (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules
multi_module_lookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
multiselectlookup	JSON	Optional
multiselectlookup (anyOf 1)	object	Alternative	Represents the multi-module lookup details of the field. Additional keys: not allowed
multiselectlookup (anyOf 1).connected_details	Model	Optional	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details
multiselectlookup (anyOf 1).linking_details	object	Optional	Represents the linking details for the multi-module lookup. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.connected_lookup_field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details connected lookup field
multiselectlookup (anyOf 1).linking_details.lookup_field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details lookup field
multiselectlookup (anyOf 1).linking_details.module	object	Required within parent	Represents the module details for the multi-module lookup. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
multiselectlookup (anyOf 1).linking_details.module.id	string	Required within parent	Id of the resource. Format: int64
multiselectlookup (anyOf 1).linking_details.module.plural_label	string	Required within parent	Represents the plural label of the module. Maximum length: 50
multiselectlookup (anyOf 1).linking_details.module.visibility	JSON	Required within parent
multiselectlookup (anyOf 1).linking_details.module.visibility (anyOf 1)	number	Alternative	Represents the visibility of the module. Format: int32
multiselectlookup (anyOf 1).linking_details.module.visibility (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
multiselectlookup (anyOf 1).related_list	Model	Optional	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list related list
multiselectlookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
multiuserlookup	Model	Optional	Expand Get field metadata by ID — response body — fields item multiuserlookup
operation_type	Model	Required within parent	Expand Get field metadata by ID — response body — fields item operation type
parent_field	JSON	Optional
parent_field (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item parent field api name, id, name
parent_field (anyOf 2)	null	Alternative	Represents the null if no information is available.
pick_list_values	JSON	Required within parent
pick_list_values (anyOf 1)	array	Alternative	Represents the list of picklist values configured for the field, applicable to picklist and multi-select picklist fields. Maximum items: 100
pick_list_values (anyOf 1)[]	object	Each item	Represents the details of a picklist value, including its display value, actual value, sequence number, and color code. Additional keys: not allowed
pick_list_values (anyOf 1)[].actual_value	string	Required within parent	Represents the actual stored value of the picklist option. Maximum length: 120
pick_list_values (anyOf 1)[].colour_code	string	Optional	Represents the colour code associated with the picklist option. Maximum length: 20
pick_list_values (anyOf 1)[].display_value	string	Required within parent	Represents the display value of the picklist option shown in the user interface. Maximum length: 120
pick_list_values (anyOf 1)[].id	string	Required within parent	Id of the resource. Format: int64
pick_list_values (anyOf 1)[].record_category_value	Model	Optional	Expand Get field metadata by ID — response body — fields item pick list values array item record category value
pick_list_values (anyOf 1)[].reference_value	string	Required within parent	Represents the reference value of the picklist option used by integrations and reports. Maximum length: 120
pick_list_values (anyOf 1)[].sequence_number	JSON	Required within parent
pick_list_values (anyOf 1)[].sequence_number (anyOf 1)	number	Alternative	Represents the order position of the picklist option in the dropdown list. Format: int32
pick_list_values (anyOf 1)[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pick_list_values (anyOf 1)[].type	string	Required within parent	Represents whether the picklist option is used or unused in the module. Maximum length: 50
pick_list_values (anyOf 2)	null	Alternative	Represents the null if no information is available.
pick_list_values_sorted_lexically	boolean	Required within parent	Indicates whether the picklist values are sorted alphabetically.
private	JSON	Optional
private (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item private export, restricted, type
private (anyOf 2)	null	Alternative	Represents the null if no information is available.
profiles	array	Required within parent	Represents the list of profiles associated with the field. Maximum items: 50
profiles[]	object	Each item	Represents the profile details. Additional keys: not allowed
profiles[].id	string	Required within parent	Id of the resource. Format: int64
profiles[].name	string	Required within parent	Represents the name of the profile. Maximum length: 60
profiles[].permission_type	string	Required within parent	Represents the type of permission granted. Maximum length: 25
public	boolean	Required within parent	Indicates if the field is public.
quick_sequence_number	string	Optional	Represents the quick sequence number of the field. Maximum length: 10
range	JSON	Required within parent
range (anyOf 1)	object	Alternative	Represents the numeric range allowed for the field, defined by the **from** and **to** values. Additional keys: not allowed
range (anyOf 1).from	JSON	Required within parent
range (anyOf 1).from (anyOf 1)	number	Alternative	Represents the starting value of the range. Format: double
range (anyOf 1).from (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 1).to	JSON	Required within parent
range (anyOf 1).to (anyOf 1)	number	Alternative	Represents the ending value of the range. Format: double
range (anyOf 1).to (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 2)	null	Alternative	Represents the null if no information is available.
read_only	boolean	Required within parent	Indicates whether the field is read-only for the current user.
record_category_tracking_field	JSON	Optional	Reference to the field used to track record category changes over time in the timeline view. Only present when enable_record_category is true and a tracking field is configured.
record_category_tracking_field (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item record category tracking field api name, id
record_category_tracking_field (anyOf 2)	null	Alternative	Represents the null if no information is available.
record_category_values	array	Optional	List of record category values defined for this picklist field. Only returned when enable_record_category is true. Maximum items: 50
record_category_values[]	object	Each item	Individual record category configuration. Additional keys: not allowed
record_category_values[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. API name of the record category. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
record_category_values[].id	string	Required within parent	Id of the resource. Unique identifier of the record category. Format: int64
record_category_values[].nature_of_category	string	Required within parent	Nature of the record category indicating sentiment or outcome. Known values: none, thumbs_up, thumbs_down
record_category_values[].value	string	Required within parent	Display value of the record category. Maximum length: 120
reference_id	string	Optional	Represents the temporary identifier used to reference a screen within the same wizard request payload. Maximum length: 255 Pattern: \{\{[a-zA-Z0-9]+\}\}
rollup_summary	JSON	Required within parent
rollup_summary (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on
rollup_summary (anyOf 2)	null	Alternative	Represents the null if no information is available.
searchable	boolean	Required within parent	Indicates if the field is searchable.
separator	boolean	Required within parent	Indicates if the field is a separator.
sharing_properties	Model	Optional	Expand Get field metadata by ID — response body — fields item sharing properties
sortable	boolean	Required within parent	Indicates if the field is sortable.
static_field	boolean	Optional	Indicates if the field is a static field
system_mandatory	boolean	Required within parent	Indicates if the field is system mandatory.
textarea	object	Optional	Represents the textarea field details. Additional keys: not allowed
textarea.type	string	Required within parent	Represents the type of the textarea. Maximum length: 50
tooltip	JSON	Optional
tooltip (anyOf 1)	object	Alternative	Represents the tooltip configuration for the field, including the tooltip type and displayed message. Additional keys: not allowed
tooltip (anyOf 1).name	string	Required within parent	Represents the it gives the name of the tool tip. Maximum length: 25
tooltip (anyOf 1).value	string	Required within parent	Represents the text for the tool tip. Maximum length: 255
tooltip (anyOf 2)	null	Alternative	Represents the null if no information is available.
type	string	Required within parent	Represents the type of the field used or unused. Maximum length: 25
ui_type	JSON	Required within parent
ui_type (anyOf 1)	number	Alternative	Represents the UI type of the field. Format: int32
ui_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unique	object	Required within parent	Represents the uniqueness details of the field. Additional keys: not allowed
unique.case_sensitive	boolean	Optional	Indicates if the uniqueness is case sensitive.
view_type	Model	Required within parent	Expand Get field metadata by ID — response body — fields item view type
virtual_field	boolean	Required within parent	Indicates if the field is a virtual field.
visible	boolean	Required within parent	Indicates if the field is visible.
webhook	boolean	Required within parent	Indicates whether webhook is enabled for the field.

Referenced models: Get field metadata by ID — response body — fields item association details lookup field, related field, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details connected lookup field, Get field metadata by ID — response body — fields item convert mapping, Get field metadata by ID — response body — fields item child fields array item field, Get field metadata by ID — response body — fields item formula Represents the formula details of the field, Get field metadata by ID — response body — fields item global picklist api name, id, Get field metadata by ID — response body — fields item history tracking duration configuration, duration configured field, followed fields, module, related list name, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details lookup field, Get field metadata by ID — response body — fields item lookup Represents the lookup field details, Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules, Get field metadata by ID — response body — fields item multiuserlookup, Get field metadata by ID — response body — fields item operation type, Get field metadata by ID — response body — fields item parent field api name, id, name, Get field metadata by ID — response body — fields item private export, restricted, type, Get field metadata by ID — response body — fields item record category tracking field api name, id, Get field metadata by ID — response body — fields item pick list values array item record category value, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list related list, Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on, Get field metadata by ID — response body — fields item sharing properties, Get field metadata by ID — response body — fields item view type

Get field metadata by ID — response body — fields item association details lookup field, related field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the association details of the lookup field, including the related field and the lookup field configuration in the connected module. Additional keys: not allowed
lookup_field	object	Required within parent	Represents the details of the lookup field. Additional keys: not allowed
lookup_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
lookup_field.id	string	Required within parent	Id of the resource. Format: int64
related_field	object	Required within parent	Represents the details of the related field. Additional keys: not allowed
related_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
related_field.id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item child fields array item field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the child Address field. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
name	string	Required within parent	Represents the name of the child Address field. Maximum length: 100

Get field metadata by ID — response body — fields item convert mapping

Field	Type	Presence	Description and constraints
$	object	Root	Represents the convert mapping details of the field. Additional keys: not allowed
Accounts	JSON	Optional
Accounts (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Accounts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Contacts	JSON	Optional
Contacts (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Contacts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Deals	JSON	Optional
Deals (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Deals (anyOf 2)	null	Alternative	Represents the null if no information is available.
Invoices	JSON	Optional
Invoices (anyOf 1)	string	Alternative	Represents the mapping details for Invoices field name. Maximum length: 100
Invoices (anyOf 2)	null	Alternative	Represents the null if no information is available.
Sales_Orders	JSON	Optional
Sales_Orders (anyOf 1)	string	Alternative	Represents the mapping details for Sales Orders field name. Maximum length: 100
Sales_Orders (anyOf 2)	null	Alternative	Represents the null if no information is available.

Get field metadata by ID — response body — fields item formula Represents the formula details of the field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the formula details of the field. Additional keys: not allowed
assume_default	boolean	Optional	Indicates if the formula should assume default values.
dynamic	boolean	Optional	Indicates if the formula is dynamic.
return_type	string	Optional	Represents the return type of the formula. Maximum length: 50
stop_compute_conditionally	boolean	Optional	Indicates if the formula computation should stop conditionally.
sub_return_type	string	Optional	Represents the sub-type of the formula return value, such as the specific string subtype when the return type is a string. Maximum length: 50

Get field metadata by ID — response body — fields item global picklist api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the global picklist details linked to the field, identified by its API name and unique ID. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item history tracking duration configuration, duration configured field, followed fields, module, related list name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the history tracking details of the field. Additional keys: not allowed
duration_configuration	string	Required within parent	Represents the duration configuration for history tracking. Maximum length: 120
duration_configured_field	object	Required within parent	Represents the duration configured field details for history tracking. Additional keys: not allowed
duration_configured_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
duration_configured_field.id	string	Required within parent	Id of the resource. Format: int64
followed_fields	array	Required within parent	Represents the list of fields being followed for history tracking. Maximum items: 100
followed_fields[]	object	Each item	Represents the details of a followed field. Additional keys: not allowed
followed_fields[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
followed_fields[].id	string	Required within parent	Id of the resource. Format: int64
module	object	Required within parent	Represents the module details for history tracking. Additional keys: not allowed
module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
module.id	string	Required within parent	Id of the resource. Format: int64
related_list_name	string	Required within parent	Represents the name of the related list for history tracking. Maximum length: 100

Get field metadata by ID — response body — fields item lookup Represents the lookup field details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field details. Additional keys: not allowed
api_name	JSON	Optional
api_name (anyOf 1)	string	Alternative	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
api_name (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_label	JSON	Optional
display_label (anyOf 1)	string	Alternative	Display label of the lookup field Maximum length: 50
display_label (anyOf 2)	null	Alternative	Represents the null if no information is available.
id	JSON	Optional
id (anyOf 1)	string	Alternative	Id of the resource. Format: int64
id (anyOf 2)	null	Alternative	Represents the null if no information is available.
module	Model	Optional	Expand Get field metadata by ID — response body — fields item lookup Represents the lookup field details module
query_details	Model	Optional	Expand Get field metadata by ID — response body — fields item lookup Represents the lookup field details query details
revalidate_filter_during_edit	boolean	Optional	Indicates if the filter should be revalidated during edit.

Referenced models: Get field metadata by ID — response body — fields item lookup Represents the lookup field details module, Get field metadata by ID — response body — fields item lookup Represents the lookup field details query details

Get field metadata by ID — response body — fields item lookup Represents the lookup field details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the lookup field. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
crypt	boolean	Required within parent	Indicates if the module is encrypted.
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item lookup Represents the lookup field details query details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the query details for the lookup field. Additional keys: not allowed
query_id	string	Optional	Represents the query ID for the lookup field. Format: int64 Maximum length: 30
system_query_id	JSON	Required within parent
system_query_id (anyOf 1)	string	Alternative	Represents the system query ID for the lookup field. Format: int64 Maximum length: 30
system_query_id (anyOf 2)	null	Alternative	Represents the null if no information is available.

Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-module lookup configuration of the field, including the display label, API name, and the list of modules the lookup references. Additional keys: not allowed
api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
display_label	string	Optional	Represents the display label of the multi module lookup. Maximum length: 50
modules	array	Optional	Represents the list of modules associated with the multi module lookup. Maximum items: 100
modules[]	Model	Each item	Expand Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules modules item

Referenced models: Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules modules item

Get field metadata by ID — response body — fields item multi module lookup api name, display label, modules modules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the module. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
module_name	string	Required within parent	Represents the name of the module. Maximum length: 50

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected details for the multi-module lookup. Additional keys: not allowed
field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details field
layouts	array	Required within parent	Represents the list of layouts associated with the multi-module lookup. Maximum items: 100
layouts[]	object	Each item	Represents the layout details for the multi-module lookup. Additional keys: not allowed
layouts[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
layouts[].id	string	Required within parent	Id of the resource. Format: int64
module	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details module

Referenced models: Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details field, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details module

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the field label of the field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
plural_label	string	Required within parent	Represents the plural label of the module. Maximum length: 50

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected lookup field details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the field label of the connected lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the field label of the lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list related list

Field	Type	Presence	Description and constraints
$	object	Root	Represents the related list details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
display_label	string	Required within parent	Represents the display label of the related list. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiuserlookup

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-user lookup details of the field. Additional keys: not allowed
linking_details	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiuserlookup linking details
record_access	boolean	Required within parent	Indicates if record access is enabled for the multi-user lookup.

Referenced models: Get field metadata by ID — response body — fields item multiuserlookup linking details

Get field metadata by ID — response body — fields item multiuserlookup linking details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the linking details for the multi-user lookup. Additional keys: not allowed
connected_lookup_field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiuserlookup linking details connected lookup field
lookup_field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiuserlookup linking details lookup field
module	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiuserlookup linking details module

Referenced models: Get field metadata by ID — response body — fields item multiuserlookup linking details connected lookup field, Get field metadata by ID — response body — fields item multiuserlookup linking details lookup field, Get field metadata by ID — response body — fields item multiuserlookup linking details module

Get field metadata by ID — response body — fields item multiuserlookup linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected lookup field details for the multi-user lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the label of the connected lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiuserlookup linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field details for the multi-user lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the label of the lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiuserlookup linking details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the multi-user lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
plural_label	string	Required within parent	Represents the plural label of the module. Maximum length: 50

Get field metadata by ID — response body — fields item operation type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the operation types allowed for the field. Additional keys: not allowed
api_create	boolean	Required within parent	Indicates whether the field can be created through the API.
api_update	boolean	Required within parent	Indicates whether the field can be updated through the API.
web_create	boolean	Required within parent	Indicates whether the field can be created through the web.
web_update	boolean	Required within parent	Indicates whether the field can be updated through the web.

Get field metadata by ID — response body — fields item parent field api name, id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the parent field of the current field, applicable to subfields such as address coordinates that belong to a composite parent field. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
name	string	Required within parent	Represents the name of the parent field. Maximum length: 50

Get field metadata by ID — response body — fields item pick list values array item record category value

Field	Type	Presence	Description and constraints
$	object	Root	Reference to an existing record category value mapped to this picklist option. **At least one identifier must be provided**: `id`, `rid`, or `api_name`. Multiple identifiers can be provided for validation purposes. Server-side validation enforces this requirement. Additional keys: not allowed
api_name	string	Optional	API name of the record category value Maximum length: 255
id	string	Optional	Unique identifier of the record category value Format: int64

Get field metadata by ID — response body — fields item private export, restricted, type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the privacy configuration of the field, including the restriction type, access restrictions, and export restrictions applied to sensitive data. Additional keys: not allowed
export	boolean	Required within parent	Indicates if the field is exportable.
restricted	boolean	Required within parent	Indicates if the field is restricted.
type	string	Required within parent	Represents the type of privacy. Maximum length: 25

Get field metadata by ID — response body — fields item record category tracking field api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Field reference for tracking record category changes. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. API name of the tracking field. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Unique identifier of the tracking field. Format: int64

Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on

Field	Type	Presence	Description and constraints
$	object	Root	Represents the rollup summary details, if available. Additional keys: not allowed
based_on_module	object	Optional	Represents the module on which the rollup summary is based. Additional keys: not allowed
based_on_module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
based_on_module.id	string	Required within parent	Id of the resource. Format: int64
expression	Model	Optional	Expand Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression
related_list	object	Optional	Represents the related list details for the rollup summary. Additional keys: not allowed
related_list.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
related_list.id	string	Required within parent	Id of the resource. Format: int64
return_type	string	Optional	Represents the return type of the rollup summary. Maximum length: 50
rollup_based_on	string	Optional	Indicates what the rollup is based on. Maximum length: 50

Referenced models: Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression

Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression

Field	Type	Presence	Description and constraints
$	object	Root	Represents the expression details of the rollup summary. Additional keys: not allowed
criteria	JSON	Optional
criteria (anyOf 1)	Model	Alternative	Expand Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value
criteria (anyOf 2)	null	Alternative	Represents the null if no information is available.
function	string	Required within parent	Represents the function used in the rollup summary. Maximum length: 25
function_parameters	array	Required within parent	Represents the list of function parameters for the rollup summary. Maximum items: 100
function_parameters[]	object	Each item	Represents the details of a function parameter. Additional keys: not allowed
function_parameters[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$

Referenced models: Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value

Get field metadata by ID — response body — fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the criteria details for the rollup summary. Additional keys: not allowed
comparator	string	Required within parent	Represents the comparator used in the criteria. Maximum length: 25
field	object	Required within parent	Represents the details of the field used in the criteria. Additional keys: not allowed
field.api_name	string	Required within parent	Represents the API name of the field. Maximum length: 100
field.id	string	Required within parent	Id of the resource. Format: int64
type	string	Required within parent	Represents the type of the criteria. Maximum length: 25
value	string	Required within parent	Represents the value used in the criteria. Maximum length: 100

Get field metadata by ID — response body — fields item sharing properties

Field	Type	Presence	Description and constraints
$	object	Root	Represents the sharing properties of the field. Additional keys: not allowed
scheduler_status	string	Required within parent	Represents the scheduler status for sharing. Maximum length: 50
share_permission	string	Required within parent	Represents the share permission for the field. Maximum length: 50
share_preference_enabled	boolean	Required within parent	Indicates if share preference is enabled.

Get field metadata by ID — response body — fields item view type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the view type details of the field. Additional keys: not allowed
create	boolean	Required within parent	Indicates if the field supports create.
edit	boolean	Required within parent	Indicates if the field is editable.
quick_create	boolean	Required within parent	Indicates if the field supports quick create.
view	boolean	Required within parent	Indicates if the field is viewable.

Get scheduled jobs for a field — response body — info, scheduled jobs

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for the scheduled jobs request, containing the list of scheduled picklist field action jobs and pagination details. Additional keys: not allowed
info	Model	Required within parent	Expand Get scheduled jobs for a field — response body — info, scheduled jobs info
scheduled_jobs	array	Required within parent	Represents the list of scheduled picklist field action jobs retrieved for the specified field. Maximum items: 200
scheduled_jobs[]	Model	Each item	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item

Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item, Get scheduled jobs for a field — response body — info, scheduled jobs info

Get scheduled jobs for a field — response body — info, scheduled jobs info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination metadata for the scheduled jobs list, including per-page size, current page, item count, and whether more records are available. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the count of the jobids. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Required within parent	Represents the more records available.
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative	Represents the page number. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Required within parent
per_page (anyOf 1)	integer	Alternative	Represents the per page count. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a scheduled job for a picklist field action (delete, replace, or delete-and-replace), including the job ID, target module, impact details, status, and message. Additional keys: not allowed
action	string	Required within parent	Represents the scheduler detail action. Known values: DELETE_PICKLIST_OPTION, REPLACE_PICKLIST_OPTION, DELETE_AND_REPLACE_PICKLIST_OPTION Maximum length: 255
details	Model	Required within parent	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details
job_id	string	Required within parent	Represents the job id of the scheduler. Format: int64
message	string	Required within parent	Represents the message of the scheduler response. Known values: Job completed, Job scheduled, Job failed, Job inprogress Maximum length: 255
module	Model	Required within parent	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module
status	string	Required within parent	Represents the status of the scheduler. Known values: SCHEDULED, FAILED, COMPLETED, INPROGRESS Maximum length: 255
$ (allOf 1)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 2)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 3)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 4)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 5)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 6)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 7)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 8)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 9)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 10)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 11)	JSON	All variants apply	Represents the description for allOf nested.
$ (allOf 12)	JSON	All variants apply	Represents the description for allOf nested.

Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the aggregated impact metrics for the scheduled job across records, workflow rules, field dependencies, and dashboard criteria affected by the picklist option change. Additional keys: not allowed
dashboard_criteria	Model	Optional	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria
field_dependency	Model	Optional	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency
records	Model	Required within parent	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details records
workflow_rules	Model	Optional	Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details workflow rules

Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details records, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details workflow rules

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria

Field	Type	Presence	Description and constraints
$	object	Root	Represents the summary of dashboard criteria impact for the job, including counts of total evaluated, processed, and failed criteria. Additional keys: not allowed
failed	JSON	Required within parent
failed (anyOf 1)	integer	Alternative	Indicates the total number of records that failed to process during the dashboard criteria evaluation. Format: int32
failed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processed	JSON	Required within parent
processed (anyOf 1)	integer	Alternative	Represents the processed records. Format: int32
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Represents the total number of records submitted for processing in the dashboard criteria evaluation, encompassing both successful and failed records. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency

Field	Type	Presence	Description and constraints
$	object	Root	Represents the summary of field dependency impact for the job, including counts of total evaluated, processed, and failed dependencies. Additional keys: not allowed
failed	JSON	Required within parent
failed (anyOf 1)	integer	Alternative	Represents the failed field dependencies. Format: int32
failed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processed	JSON	Required within parent
processed (anyOf 1)	integer	Alternative	Represents the processed field dependencies. Format: int32
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Represents the total field dependencies. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details records

Field	Type	Presence	Description and constraints
$	object	Root	Represents the summary of record-level impact for the job, including total records evaluated, successfully processed, and failed. Additional keys: not allowed
failed	JSON	Required within parent
failed (anyOf 1)	integer	Alternative	Represents the failed records. Format: int32
failed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processed	JSON	Required within parent
processed (anyOf 1)	integer	Alternative	Represents the processed records. Format: int32
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Represents the total records. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details workflow rules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the summary of workflow rule impact for the job, including counts of total evaluated, processed, and failed rules. Additional keys: not allowed
failed	JSON	Required within parent
failed (anyOf 1)	integer	Alternative	Represents the failed records. Format: int32
failed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processed	JSON	Required within parent
processed (anyOf 1)	integer	Alternative	Represents the processed records. Format: int32
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Represents the total records. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lightweight reference to the CRM module targeted by the scheduled job, including the module API name and unique identifier. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module. Maximum length: 255
id	string	Required within parent	Represents the module Id. Maximum length: 20 Minimum length: 13

Update custom fields — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for updating custom fields. Maximum of 25 fields can be updated in a single call. Additional keys: not allowed
fields	array	Optional	Specify the list of fields to update. Maximum items: 25 Minimum items: 1
fields[]	object	Each item	Specify the field update configuration. Additional keys: not allowed
fields[].association_details	JSON	Optional
fields[].association_details (anyOf 1)	object	Alternative	Specify the association details for the field, including the related field and lookup field configuration. Additional keys: not allowed
fields[].association_details (anyOf 1).lookup_field	object	Required within parent	Details of the lookup field. Additional keys: not allowed
fields[].association_details (anyOf 1).lookup_field.api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].association_details (anyOf 1).lookup_field.id	string	Optional	Id of the resource. Format: int64
fields[].association_details (anyOf 1).related_field	object	Required within parent	Details of the related field. Additional keys: not allowed
fields[].association_details (anyOf 1).related_field.api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].association_details (anyOf 1).related_field.id	string	Optional	Id of the resource. Format: int64
fields[].association_details (anyOf 2)	null	Alternative	Represents the null if no information is available.
fields[].currency	object	Optional	Currency Field Data. Additional keys: not allowed
fields[].currency.precision	string	Required within parent	Specify the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place. Maximum length: 25
fields[].currency.rounding_option	string	Required within parent	Specify how to round currency values. One of: normal, round_off, round_up, round_down Maximum length: 25
fields[].decimal_place	number	Optional	The number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive. Format: int32
fields[].field_label	string	Optional	Specify the unique display label of the field. Maximum length: 255
fields[].formula	object	Optional	Specify the details of the formula field, including the return type and the expression. Additional keys: not allowed
fields[].formula.dynamic	boolean	Optional	Specify whether the formula is Auto Refresh.
fields[].formula.expression	string	Required within parent	Specify the formula expression. Maximum length: 255
fields[].formula.return_type	string	Required within parent	Specify the return type of the formula. One of: double, currency, text, date, datetime, boolean
fields[].formula.stop_compute_conditionally	boolean	Optional	Specify whether to stop computation conditionally.
fields[].formula.stop_compute_expression	string	Optional	Specify the expression that determines when to stop computation. Maximum length: 255
fields[].formula.sub_return_type	string	Optional	Specify the string subtype of the formula return value when the return type is text. One of: small, medium, large Maximum length: 50
fields[].global_picklist	JSON	Optional
fields[].global_picklist (anyOf 1)	object	Alternative	Global picklist configuration. Additional keys: not allowed
fields[].global_picklist (anyOf 1).api_name	string	Optional	API name of the global picklist. Maximum length: 25
fields[].global_picklist (anyOf 1).id	string	Required within parent	ID of the global picklist to associate with this field. Format: int64
fields[].global_picklist (anyOf 2)	null	Alternative	Null if no information is available.
fields[].history_tracking	object	Optional	Specify the history tracking configuration. Additional keys: not allowed
fields[].history_tracking.duration_configuration	string	Optional	Specify the duration for which history is tracked. One of: days, time Maximum length: 25
fields[].history_tracking.followed_fields	array	Optional	Specify the list of fields to update. Maximum items: 10
fields[].history_tracking.followed_fields[]	object	Each item	Specify the field to be tracked. Additional keys: not allowed
fields[].history_tracking.followed_fields[]._delete	null	Optional	Set to null to remove field from tracking.
fields[].history_tracking.followed_fields[].api_name	string	Optional	Specify the API name of the field to be tracked. Maximum length: 25
fields[].history_tracking.followed_fields[].id	string	Optional	Specify the ID of the field to be tracked. Format: int64
fields[].history_tracking.related_list_name	string	Optional	Specify the name of the related list for history tracking. Maximum length: 50
fields[].history_tracking_enabled	boolean	Optional	Specify whether history tracking is enabled for the field.
fields[].id	string	Optional	Id of the resource. Format: int64
fields[].length	integer	Optional	Maximum number of characters allowed. Varies by data type. Format: int32 Maximum: 50000 Minimum: 1
fields[].lookup	object	Optional	Specify the lookup field configuration. Additional keys: not allowed
fields[].lookup.query_details	object	Optional	Specify the filter criteria for lookup records. Additional keys: not allowed
fields[].lookup.query_details.criteria	object	Optional	Specify the filter criteria for lookup fields. Additional keys: not allowed
fields[].lookup.query_details.criteria.group	array	Required within parent	Specify the array of filter conditions. Maximum items: 10
fields[].lookup.query_details.criteria.group[]	object	Each item	Specify the group criteria values. Additional keys: not allowed
fields[].lookup.query_details.criteria.group[].comparator	string	Required within parent	Specify the comparison operator. One of: equal, not_equal, like, not_like, greater_equal, greater_than, less_equal, less_than, in, not_in, starts_with, ends_with, contains, not_contains, between, not_between, include_all, include_any, exclude_all, exclude_any
fields[].lookup.query_details.criteria.group[].field	object	Required within parent	Specify the field details. Additional keys: not allowed
fields[].lookup.query_details.criteria.group[].field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].lookup.query_details.criteria.group[].field.id	string	Optional	Id of the resource. Format: int64
fields[].lookup.query_details.criteria.group[].value	JSON	Required within parent	Specify the value to compare against.
fields[].lookup.query_details.criteria.group[].value (anyOf 1)	string	Alternative	the value to be matched. Maximum length: 125
fields[].lookup.query_details.criteria.group[].value (anyOf 2)	array	Alternative	array list of value to be matched. Maximum items: 10
fields[].lookup.query_details.criteria.group[].value (anyOf 2)[]	string	Each item	the value to be matched. Maximum length: 125
fields[].lookup.query_details.criteria.group_operator	string	Optional	Specify the logical operator for multiple conditions. One of: AND, OR
fields[].pick_list_values	array	Optional	Specify the picklist configuration. Maximum items: 10
fields[].pick_list_values[]	object	Each item	PicklistValue to be shown. Additional keys: not allowed
fields[].pick_list_values[]._global_picklist_value	object	Optional	Specify the global picklist value. Additional keys: not allowed
fields[].pick_list_values[]._global_picklist_value.id	string	Required within parent	Id of the resource. Format: int64
fields[].pick_list_values[].actual_value	string	Optional	Specify the actual value of the picklist option. Once set, this value cannot be changed. Maximum length: 25
fields[].pick_list_values[].colour_code	string	Optional	Specify the hex code for the picklist value color. Maximum length: 25
fields[].pick_list_values[].display_value	string	Optional	Specify the display Value to be shown. Maximum length: 25
fields[].pick_list_values[].id	string	Optional	Id of the resource. Format: int64
fields[].pick_list_values[].reference_value	string	Optional	Specify the reference value to be Userd Internal. Maximum length: 25
fields[].profiles	array	Optional	Specify the profiles to which the field is to be assigned. Maximum items: 10
fields[].profiles[]	object	Each item	Specify the profile access and permission configuration. Additional keys: not allowed
fields[].profiles[].id	string	Required within parent	Id of the resource. Format: int64
fields[].profiles[].permission_type	string	Required within parent	Specify the permission level for this profile. One of: read_write, read_only, hidden
fields[].rollup_summary	object	Optional	Specify the rollup summary field configuration. Additional keys: not allowed
fields[].rollup_summary.based_on_module	object	Required within parent	Specify the source module for rollup. Additional keys: not allowed
fields[].rollup_summary.based_on_module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.expression	object	Required within parent	Specify the calculation expression. Additional keys: not allowed
fields[].rollup_summary.expression.criteria	object	Optional	Specify the filter criteria for lookup fields. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group	array	Required within parent	Specify the array of filter conditions. Maximum items: 10
fields[].rollup_summary.expression.criteria.group[]	object	Each item	Specify the filter details need to be added for validation action. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group[].comparator	string	Required within parent	Specify the comparison operator. One of: equal, not_equal, like, not_like, greater_equal, greater_than, less_equal, less_than, in, not_in, starts_with, ends_with, contains, not_contains, between, not_between, include_all, include_any, exclude_all, exclude_any Maximum length: 25
fields[].rollup_summary.expression.criteria.group[].field	object	Required within parent	Specify the field to be added in validation. Additional keys: not allowed
fields[].rollup_summary.expression.criteria.group[].field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.expression.criteria.group[].field.id	string	Optional	Id of the resource. Format: int64
fields[].rollup_summary.expression.criteria.group[].value	JSON	Required within parent	Specify the value to compare against.
fields[].rollup_summary.expression.criteria.group[].value (anyOf 1)	string	Alternative	the value to be matched. Maximum length: 125
fields[].rollup_summary.expression.criteria.group[].value (anyOf 2)	array	Alternative	array list of value to be matched. Maximum items: 10
fields[].rollup_summary.expression.criteria.group[].value (anyOf 2)[]	string	Each item	the value to be matched. Maximum length: 125
fields[].rollup_summary.expression.criteria.group_operator	string	Optional	Specify the logical operator for multiple conditions. One of: AND, OR
fields[].rollup_summary.expression.function	string	Required within parent	Specify the aggregation function. One of: SUM, COUNT, AVG, MIN, MAX
fields[].rollup_summary.expression.function_parameters	array	Required within parent	Specify the fields to aggregate. Maximum items: 10
fields[].rollup_summary.expression.function_parameters[]	object	Each item	Expression for the calculation need to be done. Additional keys: not allowed
fields[].rollup_summary.expression.function_parameters[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.related_list	object	Required within parent	Specify the related list for rollup. Additional keys: not allowed
fields[].rollup_summary.related_list.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].rollup_summary.return_type	string	Required within parent	Specify the return type of the rollup summary. One of: currency, double, integer
fields[].sharing_properties	object	Optional	Specify the update sharing properties for user lookup fields. Additional keys: not allowed
fields[].sharing_properties.share_permission	string	Optional	Specify the share permission. One of: full-access, read-write, read-only Maximum length: 25
fields[].sharing_properties.share_preference_enabled	boolean	Optional	Specify the share permission needed.
fields[].unique	JSON	Optional
fields[].unique (anyOf 1)	object	Alternative	Field uniqueness configuration. Additional keys: not allowed
fields[].unique (anyOf 1)._disable	JSON	Optional
fields[].unique (anyOf 1)._disable (anyOf 1)	boolean	Alternative	marking the field is not a unique key.
fields[].unique (anyOf 1)._disable (anyOf 2)	null	Alternative	Null if no information is available.
fields[].unique (anyOf 1).case_sensitive	boolean	Required within parent	Indicates whether uniqueness is case sensitive.
fields[].unique (anyOf 2)	boolean	Alternative	Indicates whether the field value must be unique across records.

Update custom fields — response body — fields

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body returned when one or more custom fields are created. Additional keys: not allowed
fields	array	Required within parent	Represents the list of creation results, one per field submitted in the request. Maximum items: 5
fields[]	Model	Each item	Expand Delete a custom field — response body — fields item

Referenced models: Delete a custom field — response body — fields item

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: ALREADY USED, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the field that is already used. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the global picklist. Maximum length: 25
exists_in	object	Optional	Represents the field due to which dependent fields are expected. Additional keys: not allowed
exists_in.api_name	string	Optional	Represents the API name of the followed field. Maximum length: 30
exists_in.json_path	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
json_path	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: AMBIGUITY DURING PROCESSING, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details about the fields causing ambiguity. Additional keys: not allowed
ambiguity_due_to	array	Optional	Represents the list of fields causing ambiguity. Maximum items: 25 Minimum items: 1
ambiguity_due_to[]	object	Each item	Represents the field due to which dependent fields are expected. Additional keys: not allowed
ambiguity_due_to[].api_name	string	Optional	Represents the API name of the ambiguous field. Maximum length: 25
ambiguity_due_to[].json_path	string	Optional	Represents the JSON path of the ambiguous field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT FIELD MISSING, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the missing dependent field details. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the global picklist. Maximum length: 25
dependee	object	Optional	Represents the field due to which dependent fields are expected. Additional keys: not allowed
dependee.api_name	string	Optional	Represents the API name of the global picklist. Maximum length: 30
dependee.json_path	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
json_path	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT MISMATCH, status: error, success details Represents the dependent mismatch details — shared_details_02ed58aa78cb

Field	Type	Presence	Description and constraints
$	object	Root	Represents the dependent mismatch details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
dependee	object	Required within parent	Represents the dependice Details . Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
dependee.json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
supported_values	array	Required within parent	Represents the list of supported values that can be provided for the field. Maximum items: 25 Minimum items: 1
supported_values[]	string	Each item	Represents the supported value. Maximum length: 255

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT MISMATCH, status: error, success details Represents the dependent mismatch details — shared_details_c02eb029dee2

Field	Type	Presence	Description and constraints
$	object	Root	Represents the dependent mismatch details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
dependee	object	Required within parent	Represents the dependice Details . Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
dependee.json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DYNAMIC EXPRESSION LENGTH EXCEEDED, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the length Exceeded details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
dependee	object	Required within parent	Represents the maximum length allowed. Additional keys: not allowed
dependee.api_name	string	Optional	Represents the API name of the global picklist. Maximum length: 25
dependee.json_path	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: EXPECTED DEPENDENT FIELD MISSING, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of missing dependent fields. Additional keys: not allowed
dependee	object	Optional	Represents the field due to which the dependent fields are expected. Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the dependee field. Maximum length: 25
dependee.json_path	string	Required within parent	Represents the JSON path of the dependee field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
expected_fields	array	Optional	Represents the list of expected dependent fields that are missing. Maximum items: 25 Minimum items: 1
expected_fields[]	object	Each item	Represents the field due to which dependent fields are expected. Additional keys: not allowed
expected_fields[].api_name	string	Required within parent	Represents the API name of the expected dependent field. Maximum length: 25
expected_fields[].json_path	string	Required within parent	Represents the JSON path of the expected dependent field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: EXPECTED FIELD MISSING, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the expected fields that are missing. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the expected field. Maximum length: 25
expected_fields	array	Optional	Represents the list of expected fields that are missing. Maximum items: 25 Minimum items: 1
expected_fields[]	object	Each item	Represents the field due to which dependent fields are expected. Additional keys: not allowed
expected_fields[].api_name	string	Optional	Represents the API name of the expected field. Maximum length: 25
expected_fields[].json_path	string	Optional	Represents the JSON path of the expected field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
json_path	string	Optional	Represents the JSON path of the expected field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INCORRECT NUMBER OF PARAM, message: The number of param is incorrect for one of the method, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the incorrect number of parameters error. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with incorrect number of parameters. Maximum length: 26
json_path	string	Required within parent	Represents the JSON path of the field with incorrect number of parameters. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details Represents the error Response for invalid data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error Response for invalid data. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that triggered the error, used to identify the specific field within the Zoho CRM module. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details Represents the request has invalid datatype

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request has invalid datatype Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 30
expected_data_type	string	Required within parent	Represents the name of the expected_data_type. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details allowed values, api name, json path

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether the given data is invalid for a list of values. Additional keys: not allowed
allowed_values	array	Required within parent	Represents the list of allowed values accepted for the JSON key identified by **api_name** and **json_path**. Maximum items: 25 Minimum items: 1
allowed_values[]	string	Each item	Represents the values can be present. Maximum length: 255
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details api name, expected data type, json path, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether the given data is invalid for a list of values. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
expected_data_type	string	Required within parent	Represents the name of the expected_data_type. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
supported_values	array	Required within parent	Represents the list of supported values accepted for the JSON key identified by **api_name** and **json_path**. Maximum items: 25 Minimum items: 1
supported_values[]	string	Each item	Represents the values can be present. Maximum length: 255

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details api name, json path, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether the given data is invalid for a list of values. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
supported_values	array	Required within parent	Represents the list of supported values accepted for the JSON key identified by **api_name** and **json_path**. Maximum items: 25 Minimum items: 1
supported_values[]	JSON	Each item
supported_values[] (anyOf 1)	string	Alternative	Represents the string values that can be present. Maximum length: 255
supported_values[] (anyOf 2)	boolean	Alternative	Represents a Boolean value that can be present in the supported values list.

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error, success details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error Response for invalid data. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$
other_details	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error, success details other details

Referenced models: Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error, success details other details

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error, success details other details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response object containing an array of errors. Additional keys: not allowed
savedCVFilters	array	Optional	Represents an array of field metadata objects. Maximum items: 100
savedCVFilters[]	object	Each item	Represents the customView unsupported criteria usage. Additional keys: not allowed
savedCVFilters[].cvid	string	Required within parent	Represents the id of the CustomView. Format: int64
savedCVFilters[].cvmodule	string	Required within parent	Represents the module Name. Maximum length: 50
savedCVFilters[].cvname	string	Required within parent	Represents the customView Name. Maximum length: 100

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: PARTICIPATING FIELD NOT FOUND, status error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the validation errors. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with incorrect data type. Maximum length: 25
id	string	Required within parent	Represents the ID of the field with incorrect data type. Maximum length: 25
json_path	string	Required within parent	Represents the JSON path of the field with incorrect data type. Maximum length: 500

Update custom fields — response body — fields / fields / item / Represents the error response structure / code: SYNTAX ERROR, message: Formula expression has syntax error, status: error details Represents the syntax error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the syntax error details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with syntax error. Maximum length: 25
id	string	Required within parent	Represents the id of the field with duplicate data. Format: int64
json_path	string	Required within parent	Represents the JSON path of the field with duplicate data. Maximum length: 500