Zoho Recruit
metadata.fields.create
To create custom fields in a module in your Zoho Recruit account.
Remote zoho/recruit
Remote (network-hosted)
Other tools also called metadata.fields.create?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"field_label",
"data_type"
],
"properties": {
"crypt": {
"oneOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"encryption",
"decryption"
],
"type": "string",
"description": "encryption: Store value encrypted. decryption: Store value unencrypted (default)"
}
},
"description": "Field encryption configuration",
"additionalProperties": false
},
{
"type": "boolean",
"description": "Indicates whether field encryption is enabled"
}
]
},
"length": {
"type": "integer",
"format": "int32",
"maximum": 50000,
"minimum": 1,
"description": "Maximum number of characters allowed. Varies by data type."
},
"lookup": {
"type": "object",
"required": [
"module"
],
"properties": {
"module": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "Module to associate via lookup",
"additionalProperties": false
},
"display_label": {
"type": "string",
"maxLength": 25,
"description": "Display label in related list"
},
"query_details": {
"type": "object",
"properties": {
"criteria": {
"type": "object",
"required": [
"group"
],
"properties": {
"group": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"comparator",
"value"
],
"properties": {
"field": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "field details",
"additionalProperties": false
},
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 125,
"description": "the value to be matched"
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 125,
"description": "the value to be matched"
},
"maxItems": 10,
"description": "array list of value to be matched"
}
],
"description": "Value to compare against"
},
"comparator": {
"enum": [
"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"
],
"type": "string",
"description": "Comparison operator"
}
},
"description": "group criteria values",
"additionalProperties": false
},
"maxItems": 10,
"description": "Array of filter conditions"
},
"group_operator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "Logical operator for multiple conditions"
}
},
"description": "Filter criteria for lookup fields",
"additionalProperties": false
}
},
"description": "Filter criteria for lookup records",
"additionalProperties": false
},
"sharing_properties": {
"type": "object",
"required": [
"share_preference_enabled",
"share_permission"
],
"properties": {
"share_permission": {
"enum": [
"full-access",
"read-write",
"read-only"
],
"type": "string",
"description": "Sharing permission level"
},
"share_with_superiors": {
"type": "boolean",
"description": "Enable share preferences"
},
"share_preference_enabled": {
"type": "boolean",
"description": "Enable share preferences"
}
},
"description": "Sharing configuration (for userlookup)",
"additionalProperties": false
},
"revalidate_filter_during_edit": {
"type": "boolean",
"default": false,
"description": "Revalidate filters during record edit"
}
},
"description": "Lookup field configuration",
"additionalProperties": false
},
"unique": {
"oneOf": [
{
"type": "object",
"required": [
"case_sensitive"
],
"properties": {
"case_sensitive": {
"type": "boolean",
"description": "Indicates whether uniqueness is case sensitive"
}
},
"description": "Field uniqueness configuration",
"additionalProperties": false
},
{
"type": "boolean",
"description": "Indicates whether the field value must be unique across records"
}
]
},
"formula": {
"type": "object",
"required": [
"expression",
"return_type"
],
"properties": {
"dynamic": {
"type": "boolean",
"description": "Indicates whether the formula is Auto Refresh"
},
"expression": {
"type": "string",
"maxLength": 255,
"description": "Formula expression"
},
"return_type": {
"enum": [
"double",
"currency",
"text",
"date",
"datetime",
"boolean"
],
"type": "string",
"description": "Return type of the formula"
},
"sub_return_type": {
"enum": [
"small",
"medium",
"large"
],
"type": "string",
"maxLength": 25,
"description": "The string return type of the formula will be split values,"
},
"stop_compute_expression": {
"type": "string",
"maxLength": 255,
"description": "Defines the expression that determines when to stop computation"
},
"stop_compute_conditionally": {
"type": "boolean",
"description": "Indicates whether to stop computation conditionally."
}
},
"description": "Contains the details of the formula field, including the return type and the expression.",
"additionalProperties": false
},
"private": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"Low",
"High"
],
"type": "string",
"description": "Privacy level for GDPR compliance"
}
},
"description": "GDPR compliance configuration",
"additionalProperties": false
},
"tooltip": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"enum": [
"static_text",
"info_icon"
],
"type": "string",
"description": "Type of tooltip: static_text (shown in field box) or info_icon (shown on icon click)"
},
"value": {
"type": "string",
"maxLength": 255,
"description": "Tooltip content. Max 35 chars for static_text, 255 chars for info_icon"
}
},
"description": "Tooltip configuration for the field",
"additionalProperties": false
},
"currency": {
"type": "object",
"required": [
"rounding_option",
"precision"
],
"properties": {
"precision": {
"type": "string",
"maxLength": 25,
"description": "Represents the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place"
},
"rounding_option": {
"enum": [
"normal",
"round_off",
"round_up",
"round_down"
],
"type": "string",
"maxLength": 25,
"description": "How to round currency values"
}
},
"description": "Currency Field Data.",
"additionalProperties": false
},
"external": {
"type": "object",
"required": [
"type",
"show"
],
"properties": {
"show": {
"type": "boolean",
"description": "Display field in UI"
},
"type": {
"enum": [
"user",
"org",
"external_lookup"
],
"type": "string",
"maxLength": 25,
"description": "user: Different ID per user. org: Common ID for organization"
}
},
"description": "External field configuration for third-party app integration",
"additionalProperties": false
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "Id of the resource."
},
"permission_type": {
"enum": [
"read_write",
"read_only",
"hidden"
],
"type": "string",
"description": "Permission level for this profile"
}
},
"description": "Profile access and permission configuration",
"additionalProperties": false
},
"maxItems": 50,
"description": "Profiles to which the field is to be assigned"
},
"textarea": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"small",
"large",
"rich_text"
],
"type": "string",
"description": "small: 2000 chars, large: 32000 chars, rich_text: 50000 chars"
}
},
"description": "Text area field configuration",
"additionalProperties": false
},
"data_type": {
"enum": [
"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"
],
"type": "string",
"maxLength": 50,
"description": "Data type of the field"
},
"separator": {
"type": "boolean",
"description": "Indicates whether to use a thousands separator for number fields"
},
"filterable": {
"type": "boolean",
"description": "Indicates whether the field can be used in filters"
},
"auto_number": {
"type": "object",
"required": [
"start_number",
"prefix",
"suffix"
],
"properties": {
"prefix": {
"type": "string",
"maxLength": 16,
"description": "Prefix of the starting number"
},
"suffix": {
"type": "string",
"maxLength": 16,
"description": "Suffix of the starting number"
},
"start_number": {
"type": "string",
"maxLength": 16,
"description": "Starting number for the auto number field"
}
},
"description": "Configuration for auto number fields",
"additionalProperties": false
},
"field_label": {
"type": "string",
"maxLength": 25,
"description": "Unique display label of the field"
},
"encrypt_case": {
"enum": [
"uppercase",
"lowercase"
],
"type": "string",
"description": "Permission case for encrypted field"
},
"decimal_place": {
"type": "number",
"format": "int32",
"description": "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."
},
"default_value": {
"type": "string",
"maxLength": 25,
"description": "Default value for the picklist field"
},
"rollup_summary": {
"type": "object",
"required": [
"return_type",
"expression",
"based_on_module",
"related_list"
],
"properties": {
"expression": {
"type": "object",
"required": [
"function_parameters",
"function"
],
"properties": {
"criteria": {
"type": "object",
"required": [
"group"
],
"properties": {
"group": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"comparator",
"value"
],
"properties": {
"field": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "Field to be added in validation",
"additionalProperties": false
},
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 125,
"description": "the value to be matched"
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 125,
"description": "the value to be matched"
},
"maxItems": 10,
"description": "array list of value to be matched"
}
],
"description": "Value to compare against"
},
"comparator": {
"enum": [
"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"
],
"type": "string",
"maxLength": 25,
"description": "Comparison operator"
}
},
"description": "Filter details need to be added for validation action",
"additionalProperties": false
},
"maxItems": 10,
"description": "Array of filter conditions"
},
"group_operator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "Logical operator for multiple conditions"
}
},
"description": "Filter criteria for lookup fields",
"additionalProperties": false
},
"function": {
"enum": [
"SUM",
"COUNT",
"AVG",
"MIN",
"MAX"
],
"type": "string",
"description": "Aggregation function"
},
"function_parameters": {
"type": "array",
"items": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"api_name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]*$",
"maxLength": 50,
"description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores."
}
},
"description": "Expression for the calculation need to be done.",
"additionalProperties": false
},
"maxItems": 10,
"description": "Fields to aggregate"
}
},
"description": "Calculation expression",
"additionalProperties": false
},
"return_type": {
"enum": [
"currency",
"double",
"integer"
],
"type": "string",
"description": "Return type of the rollup summary"
},
"related_list": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "Related list for rollup",
"additionalProperties": false
},
"based_on_module": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "Source module for rollup",
"additionalProperties": false
}
},
"description": "Rollup summary field configuration",
"additionalProperties": false
},
"global_picklist": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "ID of the global picklist to associate with this field"
},
"api_name": {
"type": "string",
"maxLength": 25,
"description": "API name of the global picklist"
}
},
"description": "Global picklist configuration",
"additionalProperties": false
},
"history_tracking": {
"type": "object",
"required": [
"related_list_name",
"duration_configuration",
"followed_fields"
],
"properties": {
"followed_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"api_name",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "ID of the field to be tracked"
},
"api_name": {
"type": "string",
"maxLength": 25,
"description": "API name of the field to be tracked"
}
},
"description": "Field to be tracked",
"additionalProperties": false
},
"maxItems": 10,
"description": "List of fields to be tracked"
},
"related_list_name": {
"type": "string",
"maxLength": 50,
"description": "Name of the related list for history tracking"
},
"duration_configuration": {
"enum": [
"days",
"time"
],
"type": "string",
"maxLength": 25,
"description": "Duration for which history is tracked"
}
},
"description": "History tracking configuration",
"additionalProperties": false
},
"number_separator": {
"type": "boolean",
"description": "Specify whether to display the field value in formatted view. The default value is true."
},
"pick_list_values": {
"type": "array",
"items": {
"type": "object",
"required": [
"display_value",
"actual_value"
],
"properties": {
"colour_code": {
"type": "string",
"maxLength": 25,
"description": "Hex code for the picklist value color"
},
"actual_value": {
"type": "string",
"maxLength": 25,
"description": "Actual Value it wolud not be changed form initial value"
},
"display_value": {
"type": "string",
"maxLength": 25,
"description": "Display Value to be shown"
},
"reference_value": {
"type": "string",
"maxLength": 25,
"description": "Reference value to be Userd Internal"
}
},
"description": "PicklistValue to be shown.",
"additionalProperties": false
},
"maxItems": 10,
"description": "picklist configuration "
},
"multiselectlookup": {
"type": "object",
"required": [
"connected_details",
"linking_details"
],
"properties": {
"linking_details": {
"type": "object",
"required": [
"module"
],
"properties": {
"module": {
"type": "object",
"required": [
"plural_label"
],
"properties": {
"plural_label": {
"type": "string",
"maxLength": 25,
"description": "Plural label for linking module"
}
},
"description": "Module name passed as parameter is case insensitive. For example, the module name 'Leads'.",
"additionalProperties": false
}
},
"description": "Linking module details",
"additionalProperties": false
},
"connected_details": {
"type": "object",
"required": [
"module",
"field"
],
"properties": {
"field": {
"type": "object",
"required": [
"field_label"
],
"properties": {
"field_label": {
"type": "string",
"maxLength": 25,
"description": "Field label in connected module"
}
},
"description": "field details",
"additionalProperties": false
},
"module": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"api_name": {
"$ref": "#/components/schemas/ApiName"
}
},
"description": "API name of module to connect",
"additionalProperties": false
}
},
"description": "Details of the module to connect",
"additionalProperties": false
}
},
"description": "Multi-select lookup field configuration",
"additionalProperties": false
},
"enable_colour_code": {
"type": "boolean",
"description": "Indicates whether colour coding is enabled for the picklist field"
},
"enable_record_state": {
"type": "boolean",
"description": "Indicates whether record state is enabled for the picklist field"
},
"_update_existing_records": {
"type": "boolean",
"description": "Update existing auto-number records with new format"
},
"hipaa_compliance_enabled": {
"type": "boolean",
"description": "Enable HIPAA compliance for this field"
},
"history_tracking_enabled": {
"type": "boolean",
"description": "Indicates whether history tracking is enabled for the field"
},
"pick_list_values_sorted_lexically": {
"type": "boolean",
"description": "Indicates whether picklist values are sorted lexically"
}
},
"description": " list of field need to be created",
"additionalProperties": false
},
"maxItems": 5,
"minItems": 1,
"description": "List of fields to be created"
},
"module": {
"type": "string",
"maxLength": 100,
"description": "Specifies the module name"
}
}
}