Zoho Recruit
metadata.fields.update
To update custom fields in your Zoho Recruit account.
Remote zoho/recruit
Remote (network-hosted)
Other tools also called metadata.fields.update?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "Id of the resource."
},
"length": {
"type": "integer",
"format": "int32",
"maximum": 50000,
"minimum": 1,
"description": "Maximum number of characters allowed. Varies by data type."
},
"lookup": {
"type": "object",
"required": [],
"properties": {
"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": {
"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": "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
}
},
"description": "Lookup field configuration",
"additionalProperties": false
},
"unique": {
"oneOf": [
{
"type": "object",
"required": [
"case_sensitive"
],
"properties": {
"_disable": {
"oneOf": [
{
"type": "boolean",
"description": "marking the field is not a unique key"
},
{
"type": "null",
"description": "Null if no information is available."
}
]
},
"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": 50,
"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
},
"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
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"permission_type"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"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": 10,
"description": "Profiles to which the field is to be assigned"
},
"field_label": {
"type": "string",
"maxLength": 255,
"description": "Unique display label of the 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."
},
"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": {
"$ref": "#/components/schemas/ApiName"
}
},
"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": {
"oneOf": [
{
"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
},
{
"type": "null",
"description": "Null if no information is available."
}
]
},
"history_tracking": {
"type": "object",
"required": [],
"properties": {
"followed_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "ID of the field to be tracked"
},
"_delete": {
"type": "null",
"description": "Set to null to remove field from tracking"
},
"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
},
"pick_list_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"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"
},
"_global_picklist_value": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
}
},
"description": "Global picklist value",
"additionalProperties": false
}
},
"description": "PicklistValue to be shown.",
"additionalProperties": false
},
"maxItems": 10,
"description": "picklist configuration "
},
"sharing_properties": {
"type": "object",
"properties": {
"share_permission": {
"enum": [
"full-access",
"read-write",
"read-only"
],
"type": "string",
"maxLength": 25,
"description": "share permission"
},
"share_preference_enabled": {
"type": "boolean",
"description": "share permission needed"
}
},
"description": "Update sharing properties for user lookup fields",
"additionalProperties": false
},
"history_tracking_enabled": {
"type": "boolean",
"description": "Indicates whether history tracking is enabled for the field"
}
},
"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"
}
}
}