FieldUpdate v8 OAS. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 6 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Field Updates",
"description": "FieldUpdate v8 OAS",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.UPDATE",
"ZohoCRM.settings.automation_actions.DELETE",
"ZohoCRM.settings.automation_actions.READ",
"ZohoCRM.settings.automation_actions.CREATE",
"ZohoCRM.settings.automation_actions.ALL"
]
}
],
"paths": {
"/settings/automation/field_updates": {
"get": {
"summary": "To retrieve all field updates",
"description": "Retrieve all available field updates",
"operationId": "getFieldUpdates",
"parameters": [
{
"$ref": "#/components/parameters/ParamQuerySortOrder"
},
{
"$ref": "#/components/parameters/ParamQuerySortBy"
},
{
"$ref": "#/components/parameters/ParamQueryIncludeInnerDetails1"
},
{
"$ref": "#/components/parameters/ParamQueryPage"
},
{
"$ref": "#/components/parameters/ParamQueryPerPage"
}
],
"responses": {
"200": {
"description": "Represents that all field updates have been retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetfieldupdatesResponse200"
}
}
}
},
"204": {
"description": "No content"
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to read all the field update details.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"post": {
"summary": "To create a field update action",
"description": "To create a field update action in the Automation module. This action modifies field values when triggered by workflows, blueprints, or approval processes.",
"operationId": "postFieldUpdates",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostfieldupdatesRequest"
}
}
}
},
"responses": {
"201": {
"description": "Represents the success response of Field Update creation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostfieldupdatesResponse201"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore552800690"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with field_updates",
"properties": {
"field_updates": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1609075774"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1296580093"
},
{
"$ref": "#/components/schemas/ErrorResponseCore467453316"
},
{
"$ref": "#/components/schemas/ErrorResponseCore115741934"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1841130033"
},
{
"$ref": "#/components/schemas/ErrorResponseCore984011800"
},
{
"$ref": "#/components/schemas/ErrorResponseCore45599694"
},
{
"$ref": "#/components/schemas/ErrorResponseCore978443965"
}
]
},
"maxItems": 25
}
},
"required": [
"field_updates"
]
}
]
}
}
}
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to create a field update action.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.CREATE"
]
}
]
},
"delete": {
"summary": "To delete multiple field update actions",
"description": "To delete multiple field update actions configured",
"operationId": "deleteFieldUpdates",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
}
],
"responses": {
"200": {
"description": "Deletes one or more field updates specified in the ids parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletefieldupdatesResponse200"
}
}
}
},
"207": {
"description": "Indicates that one or more field updates failed to delete while at least one was deleted successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletefieldupdatesResponse207"
}
}
}
},
"400": {
"description": "Indicates that all field update delete operations failed.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2006990805"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with field_updates",
"properties": {
"field_updates": {
"type": "array",
"description": "Array of error objects",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore44302846"
},
{
"$ref": "#/components/schemas/ErrorResponseCore44302847"
}
]
},
"maxItems": 25
}
},
"required": [
"field_updates"
]
}
]
}
}
}
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to delete field update details.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.DELETE"
]
}
]
}
},
"/settings/automation/field_updates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Field Update action id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
],
"get": {
"summary": "To retrieve a field update action by fieldUpdate ID",
"description": "Retrieves the details of the field-update action for the specified fieldUpdate ID.",
"operationId": "getFieldUpdateById",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIncludeInnerDetails"
}
],
"responses": {
"200": {
"description": "FieldUpdate GET API Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Get3361265000006103409Response200"
}
}
}
},
"204": {
"description": "No content"
},
"400": {
"description": "Missing required parameter: include_inner_details",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2006990805"
}
]
}
}
}
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to read a field update details.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"put": {
"summary": "To update an existing field update action",
"description": "To update an existing field update action.",
"operationId": "putFieldUpdateById",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Put3361265000006103409Request"
}
}
}
},
"responses": {
"200": {
"description": "Represents the success response for a field update modification.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Put3361265000006103409Response200"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore552800690"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1944579408"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1522103906"
},
{
"$ref": "#/components/schemas/ErrorResponseCore467453316"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with field_updates",
"properties": {
"field_updates": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore115741934"
},
{
"$ref": "#/components/schemas/ErrorResponseCore984011800"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1841130033"
},
{
"$ref": "#/components/schemas/ErrorResponseCore978443965"
}
]
},
"maxItems": 25
}
},
"required": [
"field_updates"
]
}
]
}
}
}
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to edit a field update action.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.UPDATE"
]
}
]
},
"delete": {
"summary": "To delete a fieldupdate action",
"description": "To delete a field update action.",
"operationId": "deleteFieldUpdateById",
"responses": {
"200": {
"description": "Indicates that the field update was deleted successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Delete3361265000006103409Response200"
}
}
}
},
"400": {
"description": "Field update deletion is not allowed because it is associated with an automation feature.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1944579408"
},
{
"$ref": "#/components/schemas/ErrorResponseCore702850683"
},
{
"$ref": "#/components/schemas/ErrorResponseCore685771708"
}
]
}
}
}
},
"403": {
"description": "Indicates that the user does not have the necessary permissions to edit a field update action.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2113490893"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.DELETE"
]
}
]
}
}
},
"components": {
"schemas": {
"FieldUpdatesNested1": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for field_updates",
"properties": {
"code": {
"type": "string",
"description": "Field: code",
"maxLength": 255
},
"details": {
"$ref": "#/components/schemas/DetailsNested"
},
"message": {
"type": "string",
"description": "Field: message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Field: status",
"maxLength": 255
}
}
},
"PostfieldupdatesResponse201": {
"type": "object",
"additionalProperties": false,
"description": "Represents the success response of Field Update creation.",
"properties": {
"field_updates": {
"type": "array",
"description": "Field: field_updates",
"items": {
"$ref": "#/components/schemas/FieldUpdatesNested1"
},
"maxItems": 1
}
}
},
"ErrorResponseCore552800690": {
"type": "object",
"additionalProperties": false,
"description": "Invalid data type for field: field_updates",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"invalid data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"Put3361265000006103409Response200": {
"type": "object",
"additionalProperties": false,
"description": "Represents the success response for a field update modification.",
"properties": {
"field_updates": {
"type": "array",
"description": "Field: field_updates",
"items": {
"$ref": "#/components/schemas/FieldUpdatesNested1"
},
"maxItems": 1
}
}
},
"FieldNested": {
"type": "object",
"additionalProperties": false,
"description": "Specify the API name and the unique ID of the field to be updated.",
"properties": {
"ui_type": {
"type": "integer",
"format": "int32",
"description": "Field: ui_type"
},
"id": {
"type": "string",
"description": "Unique ID of the field to be updated.",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "API name of the field to be updated.",
"maxLength": 255
}
}
},
"ErrorResponseCore978443965": {
"type": "object",
"additionalProperties": false,
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
},
"supported_values": {
"type": "array",
"description": "Detail field: supported_values",
"items": {
"type": "string",
"description": "Detail Field: supported_values",
"maxLength": 255
},
"maxItems": 25
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Invalid data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"LockStatusNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for lock_status",
"properties": {
"locked": {
"type": "boolean",
"description": "Field: locked"
}
}
},
"DetailsNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for details",
"properties": {
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
}
},
"ErrorResponseCore1944579408": {
"type": "object",
"additionalProperties": false,
"description": "Represents an invalid field update ID.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Detail field: resource_path_index"
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"the id given seems to be invalid"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"DependentFieldsNested": {
"type": "object",
"additionalProperties": false,
"description": "Specify the dependent fields that are affected when the target field is updated",
"properties": {
"field": {
"$ref": "#/components/schemas/FieldNested",
"description": "Specify the API name and Id of the dependent field to be updated. (Required)"
},
"value": {
"type": "string",
"description": "Contains value of the dependent field (Required)",
"maxLength": 255
}
},
"required": [
"field",
"value"
]
},
"ErrorResponseCore115741934": {
"type": "object",
"additionalProperties": false,
"description": "Represents one or more dependent fields are missing.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DEPENDENT_FIELD_MISSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"dependee": {
"type": "object",
"additionalProperties": false,
"description": "Detail field: dependee",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
}
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Dependent Field missing"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"CreatedByNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for created_by",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
}
},
"ErrorResponseCore1296580093": {
"type": "object",
"additionalProperties": false,
"description": "Represents field ID and API name do not match the same field.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"AMBIGUITY_DURING_PROCESSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"ambiguity_due_to": {
"type": "array",
"description": "Detail field: ambiguity_due_to",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Detail Field: ambiguity_due_to",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
}
},
"maxItems": 25
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"The field api name seems to be invalid"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1522103906": {
"type": "object",
"additionalProperties": false,
"description": "Indicates that no field update ID was provided for the edit operation.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"param_name": {
"type": "string",
"description": "Detail field: param_name",
"maxLength": 255
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"the id given seems to be invalid"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"RelatedRecordsNested": {
"type": "object",
"additionalProperties": false,
"description": "Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the related record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique id of the related rec",
"maxLength": 255
}
}
},
"Delete3361265000006103409Response200": {
"type": "object",
"additionalProperties": false,
"description": "Indicates that the field update was deleted successfully.",
"properties": {
"field_updates": {
"type": "array",
"description": "Field: fiel
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-field-updates-openapi.json