Zoho: Field updates schemas

← Field updates operations · All schemas

Create Field Update — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The request body wrapper for creating or updating a field update action. Must contain a field_updates array with exactly one entry. Additional keys: not allowed
field_updates	array	Required within parent	Array containing one field update configuration object. Exactly one item is allowed per request. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — request body — body field updates item

Referenced models: Create Field Update — request body — body field updates item

Create Field Update — request body — body field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single field update action, including the target module, target field, mapping type, and the value to apply. Some properties are conditionally required depending on the target field's type — for example, Owner fields require notify and related_records. Additional keys: not allowed
apply_assignment_threshold	boolean	Optional	Whether to enforce assignment-threshold rules when updating the Owner field. This key is applicable only for Owner updates, and is required only when active owner-assignment thresholds exist for the module. If thresholds are not configured, sending this key can be rejected as not allowed. Default: false
dependent_fields	array or null	Optional	Dependent fields that must be set alongside the target field. Required for dependent picklist relationships. Common chains: Pipeline -> Stage, Layout -> Pipeline, and Layout -> Pipeline -> Stage (nested via dependent_fields inside the Pipeline node). Maximum items: 1
dependent_fields[]	Model	Each item	Expand Create Field Update — request body — body field updates item dependent fields item
feature_type	string	Optional	Automation feature where this field update action is used. Supports baseline features plus connected_workflows. No cadence support. The automation feature this field update is associated with. Defaults to 'workflow' if omitted. All enum values are supported for creation via API. One of: workflow, approval_process, blueprint_transition, blueprint_state, assignment_rules, kiosk, commandcenter_service, connected_workflows Maximum length: 255
field	Model	Required within parent	Expand Create Field Update — request body — body field updates item field Target field to be updated. Provide both field.id and field.api_name. If both are present but inconsistent, ambiguity or invalid-data errors can be returned.
module	Model	Required within parent	Expand Create Field Update — request body — body field updates item module The CRM module where this field update should be applied. Specify using the module's unique ID and/or API name (e.g., Deals, Leads, Contacts).
name	string	Required within parent	Name of the field update action. Must be unique within the org. This label is displayed in the automation rule configuration UI. Maximum length: 255
notify	boolean	Optional	Whether to send an email notification to the new owner when the Owner field is updated. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED). Default: false
related_module	Model	Optional	Expand Create Field Update — request body — body field updates item related module Related module context when the field update is configured on a related module's records (e.g., updating a field on Contacts related to Accounts). Pass null or omit when not applicable.
related_records	array or null	Optional	Related modules whose open record ownership should also be transferred when the Owner field is updated. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED). Pass null to skip ownership transfer on related records. Maximum items: 5
related_records[]	Model	Each item	Expand Create Field Update — request body — body field updates item related records item
type	string	Required within parent	The mapping type used when creating or updating the field update action. Only static is accepted; merge_field appears only in GET responses for existing actions. Create/update mapping type. Only static is accepted for create/update payloads. One of: static Maximum length: 255
update_type	Model	Optional	Expand Create Field Update — request body — body field updates item update type Strategy for applying the value. Required for multi-select fields: 'overwrite' replaces all existing values, 'append' adds to them. Omit or pass null for single-value fields.
value	JSON	Required within parent	The value to assign to the target field when this action is triggered. The type must match the target field's data type - a mismatch returns DEPENDENT_MISMATCH. Pipeline expects a string value from Pipelines metadata; Layout expects a layout object from Layouts metadata; Owner expects a user object from Users API.
value (anyOf 1)	string	Alternative	A string value used for text, single-picklist, date, or Pipeline fields. Picklist and Pipeline values are validated against the field's configured options. Maximum length: 255
value (anyOf 2)	Model	Alternative	Expand Create Field Update — request body — body field updates item value array
value (anyOf 3)	Model	Alternative	Expand Create Field Update — request body — body field updates item value id, name
value (anyOf 4)	boolean	Alternative	A boolean value used for checkbox fields, where true marks the field as checked and false marks it as unchecked.
value (anyOf 5)	number	Alternative	A numeric value used for number, currency, decimal, or percentage fields.
value (anyOf 6)	null	Alternative	Null value - clears/empties the target field, removing any previously set value.

Referenced models: Create Field Update — request body — body field updates item dependent fields item, Create Field Update — request body — body field updates item field, Create Field Update — request body — body field updates item value array, Create Field Update — request body — body field updates item value id, name, Create Field Update — request body — body field updates item update type, Create Field Update — request body — body field updates item module, Create Field Update — request body — body field updates item related module, Create Field Update — request body — body field updates item related records item

Create Field Update — request body — body field updates item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	A dependent field that must be included alongside the target field's value, used when the target field's valid options depend on another field (for example, Pipeline requires Stage). Supports nesting up to 3 levels. Additional keys: not allowed
dependent_fields	array	Optional	Nested dependent fields that must be set when the current dependent field itself has further dependencies. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Create Field Update — request body — body field updates item dependent fields item dependent fields item
field	Model	Required within parent	Expand Create Field Update — request body — body field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Create Field Update — request body — body field updates item dependent fields item dependent fields item, Create Field Update — request body — body field updates item field

Create Field Update — request body — body field updates item dependent fields item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	Second-level dependent field in a chained dependency. Example: Stage in a Pipeline -> Stage chain. Additional keys: not allowed
dependent_fields	array	Optional	Third-level dependent fields for deeper dependency chains. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Create Field Update — request body — body field updates item dependent fields item dependent fields item dependent fields item
field	Model	Required within parent	Expand Create Field Update — request body — body field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Create Field Update — request body — body field updates item dependent fields item dependent fields item dependent fields item, Create Field Update — request body — body field updates item field

Create Field Update — request body — body field updates item dependent fields item dependent fields item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	Third-level (deepest) dependent field in a chained dependency. No further nesting is supported beyond this level. Additional keys: not allowed
field	Model	Required within parent	Expand Create Field Update — request body — body field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Create Field Update — request body — body field updates item field

Create Field Update — request body — body field updates item field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the target field to update. Requires both id and api_name; if they refer to different fields, the request fails with AMBIGUITY_DURING_PROCESSING. Additional keys: not allowed
api_name	string	Required within parent	API name of the CRM field (e.g., Deal_Name, Pipeline, Owner, Layout, Multi_Select_1). Maximum length: 255
data_type	string	Optional	Data type of the CRM field, for example text, picklist, or lookup. Maximum length: 255
field_label	string	Optional	Display label of the CRM field, as shown in the CRM UI. Maximum length: 255
id	string	Required within parent	Unique identifier of the CRM field. Mandatory in create/update payloads. Maximum length: 255
ui_type	integer	Optional	Internal UI type code for the field. Present only in response; not required in requests. Format: int32

Create Field Update — request body — body field updates item module

Field	Type	Presence	Description and constraints
$	object	Root	Module metadata for the primary CRM module associated with the field update action. Additional keys: not allowed
api_name	string	Required within parent	CRM module API name used in automation configuration (e.g., Leads, Contacts, Deals). Maximum length: 255
id	string	Optional	Unique identifier of the CRM module corresponding to api_name. Maximum length: 255
moduleName	string	Optional	Internal module name. Present only in responses. Maximum length: 255
plural_label	string	Optional	Plural display label of the module (e.g., Deals, Leads). Present only in responses. Maximum length: 255
singular_label	string	Optional	Singular display label of the module (e.g., Deal, Lead). Present only in responses. Maximum length: 255

Create Field Update — request body — body field updates item related module

Field	Type	Presence	Description and constraints
$	object or null	Root	Related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed
api_name	string	Optional	CRM related-module API name used in automation configuration (e.g., Notes). Maximum length: 255
id	string	Optional	Unique identifier of the related CRM module corresponding to api_name. Maximum length: 255

Create Field Update — request body — body field updates item related records item

Field	Type	Presence	Description and constraints
$	object	Root	Identifies a related module whose open records' ownership should be transferred alongside the parent record when the Owner field is updated. Available modules depend on the parent module context. Additional keys: not allowed
api_name	string	Required within parent	API name of the related module. Events, Calls, Tasks - open activity records, available for all modules. Contacts - available only when the parent module is Accounts. Deals - available when the parent module is Accounts or Contacts. One of: Events, Calls, Tasks, Contacts, Deals Maximum length: 255
id	string	Optional	Unique identifier of the related module. This is the module ID corresponding to the api_name. Maximum length: 255

Create Field Update — request body — body field updates item update type

Field	Type	Presence	Description and constraints
$	string or null	Root	Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields. One of: overwrite, append, null Maximum length: 255

Create Field Update — request body — body field updates item value array

Field	Type	Presence	Description and constraints
$	array	Root	An array of string values used for multi-select picklist fields, where each element represents one selected option. Maximum items: 25
$[]	string	Each item	Individual option value for the multi-select field. Maximum length: 255

Create Field Update — request body — body field updates item value id, name

Field	Type	Presence	Description and constraints
$	object	Root	An object value used for Owner or Layout fields, identified by id (a user ID for Owner fields or a layout ID for Layout fields), with an optional name for display. Additional keys: not allowed
id	string	Required within parent	Unique identifier of the user to assign as the new owner. Maximum length: 255
name	string	Optional	Optional display name for readability. Maximum length: 255

Create Field Update — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response returned when a field update action is created. Contains an array with a single result object indicating the outcome and the server-generated ID of the new field update. Additional keys: not allowed
field_updates	array	Optional	Array containing the result of the create operation. Always contains exactly one item since only one field update can be created per request. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — response body — field updates item

Referenced models: Create Field Update — response body — field updates item

Create Field Update — response body — field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Result object for a field update create, update, or delete operation. Contains the operation outcome code, a human-readable message, the status, and details including the server-generated ID. Additional keys: not allowed
code	string	Required within parent	Operation result code. 'SUCCESS' for successful operations. In bulk operations (DELETE 207), individual items may return error codes like 'NOT_ALLOWED' or 'INVALID_DATA'. Known values: SUCCESS, NOT_ALLOWED, INVALID_DATA Maximum length: 255
details	Model	Required within parent	Expand Create Field Update — response body — field updates item details
message	string	Required within parent	Human-readable message describing the operation outcome. Maximum length: 255
status	string	Required within parent	Overall status of the operation. 'success' for successful operations, 'error' for failed individual items in bulk operations. Known values: success, error Maximum length: 255

Referenced models: Create Field Update — response body — field updates item details

Create Field Update — response body — field updates item details

Field	Type	Presence	Description and constraints
$	object	Root	Details object within an action result, containing the server-generated unique identifier of the created, updated, or deleted field update action. Additional keys: not allowed
id	string	Required within parent	Unique identifier of the field update action that was created, updated, or deleted. Maximum length: 255

Delete Field Update — response body

Field	Type	Presence	Description and constraints
$	object	Root	Indicates that the field update was deleted successfully. Additional keys: not allowed
field_updates	array	Optional	Array containing the deleted field update action. Contains exactly one item. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — response body — field updates item

Referenced models: Create Field Update — response body — field updates item

Get Field Update By Id — response body — field updates

Field	Type	Presence	Description and constraints
$	object	Root	Response payload for retrieving a single field update action by ID. Additional keys: not allowed
field_updates	array	Optional	Array containing the matched field update action. Contains one item for a valid ID. Maximum items: 1
field_updates[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item

Referenced models: Get Field Update By Id — response body — field updates field updates item

Get Field Update By Id — response body — field updates field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Represents one field update action returned by the list API, including field configuration, update behavior, module context, and audit metadata. Additional keys: not allowed
apply_assignment_threshold	boolean	Optional	Whether assignment-threshold rules (record count limits per user) should be enforced when updating the field. Only applicable when the target field is an Owner field and the org has assignment thresholds configured. When true, the system checks whether the new owner has reached their record limit before applying the update. Ignored for non-Owner fields.
associated	boolean	Optional	Whether this action is currently linked to any automation rule, approval process, or blueprint.
created_by	Model	Optional	Expand Get Field Update By Id — response body — field updates field updates item created by User who created this field update action.
created_time	string	Optional	Date-time when this field update action was created. Maximum length: 255
deletable	boolean	Optional	Represents whether the current user can delete this field update action.
dependent_fields	JSON	Optional
dependent_fields (anyOf 1)	array	Alternative	Dependent fields that must be set alongside the target field when dependency rules apply. Includes patterns such as Pipeline -> Stage and Layout -> Pipeline -> Stage (nested). Nested dependencies can be represented through dependent_fields within each item. Null when the target field has no dependency rules configured. Maximum items: 10
dependent_fields (anyOf 1)[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item
dependent_fields (anyOf 2)	null	Alternative	Dependent fields that must be set alongside the target field when dependency rules apply. Includes patterns such as Pipeline -> Stage and Layout -> Pipeline -> Stage (nested). Nested dependencies can be represented through dependent_fields within each item. Null when the target field has no dependency rules configured. Maximum items: 10
dependent_fields (anyOf 2)[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item
editable	boolean	Optional	Whether the current user can edit this field update action.
feature_type	string	Optional	Automation feature where this field update action is used. Supports baseline features plus connected_workflows. No cadence support. Automation feature where this field update action is used. Known values: workflow, approval_process, blueprint_transition, blueprint_state, assignment_rules, kiosk, commandcenter_service, connected_workflows Maximum length: 255
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field The target CRM field that this action updates.
id	string	Optional	Unique identifier of the field update action. Maximum length: 20
lock_status	Model	Optional	Expand Get Field Update By Id — response body — field updates field updates item lock status Indicates whether this field update action is locked for edit/delete.
modified_by	Model	Optional	Expand Get Field Update By Id — response body — field updates field updates item modified by User who last modified this field update action.
modified_time	string	Optional	Date-time when this field update action was last modified. Maximum length: 255
module	Model	Required within parent	Expand Create Field Update — request body — body field updates item module Primary CRM module on which this field update action is configured.
name	string	Required within parent	Display name of the field update action. Maximum length: 255
notify	boolean	Optional	Whether to send an email notification to the new record owner when the Owner field is updated via this action. Only applicable when the target field is an Owner field. When true, the newly assigned owner receives an email informing them of the ownership change. Ignored for non-Owner fields.
parent_module	JSON	Optional
parent_module (anyOf 1)	object	Alternative	Parent module context when the field update is configured on a child module. Null when the field update is on a top-level module. Additional keys: not allowed
parent_module (anyOf 1).api_name	string	Optional	API name of the parent CRM module. Maximum length: 255
parent_module (anyOf 1).id	string	Optional	Unique identifier of the parent CRM module. Maximum length: 20
parent_module (anyOf 2)	null	Alternative	Parent module context when the field update is configured on a child module. Null when the field update is on a top-level module. Additional keys: not allowed
parent_module (anyOf 2).api_name	string	Optional	API name of the parent CRM module. Maximum length: 255
parent_module (anyOf 2).id	string	Optional	Unique identifier of the parent CRM module. Maximum length: 20
related_module	Model	Optional	Expand Get Field Update By Id — response body — field updates field updates item related module Related module context when the automation is configured on related records; null when not applicable.
related_records	JSON	Optional
related_records (anyOf 1)	array	Alternative	List of related modules whose record ownership should also be transferred along with the parent record when the Owner field is updated. Only applicable when the target field is an Owner field. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional related modules are available depending on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when the target field is not an Owner field or when no related modules are selected for ownership transfer. Maximum items: 5
related_records (anyOf 1)[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item related records null item
related_records (anyOf 2)	null	Alternative	List of related modules whose record ownership should also be transferred along with the parent record when the Owner field is updated. Only applicable when the target field is an Owner field. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional related modules are available depending on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when the target field is not an Owner field or when no related modules are selected for ownership transfer. Maximum items: 5
related_records (anyOf 2)[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item related records null item
source	string	Optional	Source application that created or manages this action (e.g., crm). Maximum length: 255
type	string	Required within parent	Response-only field update type. Create/update supports only static, while GET responses may include merge_field for pre-existing actions. Type returned by the API for this field update. Create/update accepts only static; GET responses can include merge_field for pre-existing actions. Known values: static, merge_field Maximum length: 255
update_type	Model	Optional	Expand Get Field Update By Id — response body — field updates field updates item update type Specifies how the field value should be applied when the target field supports multiple update strategies (e.g., multi-select picklist, Owner). Null when the field type does not support multiple update strategies (e.g., text, single picklist).
value	JSON	Required within parent	The value configured for the field update. The shape depends on the target field type.
value (anyOf 1)	string	Alternative	A plain text value. Used when the target field is a single-value field such as a text field (e.g., Deal_Name), picklist (e.g., Pipeline, Stage), number, date, or similar scalar field types. Example: "PostTest", "Qualification". Maximum length: 255
value (anyOf 2)	array	Alternative	An array of selected option values. Used when the target field is a multi-select picklist. Each element represents one selected option. Example: ["Option 1", "Option 2"]. Maximum items: 25
value (anyOf 2)[]	string	Each item	One selected option value for the multi-select field. Maximum length: 255
value (anyOf 3)	object	Alternative	A structured object value. Used when the target field requires composite data - for example, a Layout field (with id, name, display_label), an Owner/user-lookup field (with id, name), or other lookup-type fields that resolve to a resource with an identifier. Additional keys: allowed
value (anyOf 4)	boolean	Alternative	A boolean value. Used when the target field is a checkbox or boolean-type field. true enables/checks the field, false disables/unchecks it.
value (anyOf 5)	JSON	Alternative
value (anyOf 5) (anyOf 1)	number	Alternative	A numeric value. Used when the target field is a number, currency, decimal, or percentage field type. Example: 100, 25.5.
value (anyOf 5) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 6)	null	Alternative	A null value. Used to clear/empty the target field - equivalent to choosing 'empty value' in the field update configuration.

Referenced models: Get Field Update By Id — response body — field updates field updates item created by, Get Field Update By Id — response body — field updates field updates item lock status, Get Field Update By Id — response body — field updates field updates item modified by, Create Field Update — request body — body field updates item module, Get Field Update By Id — response body — field updates field updates item dependent fields null item, Get Field Update By Id — response body — field updates field updates item field, Get Field Update By Id — response body — field updates field updates item update type, Get Field Update By Id — response body — field updates field updates item related module, Get Field Update By Id — response body — field updates field updates item related records null item

Get Field Update By Id — response body — field updates field updates item created by

Field	Type	Presence	Description and constraints
$	object	Root	User who created the field update action, including display name and unique identifier. Additional keys: not allowed
id	string	Optional	Unique identifier of the user who created the resource. Maximum length: 255
name	string	Optional	Display name of the user who created the resource. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item dependent fields null item

Field	Type	Presence	Description and constraints
$	object	Root	A dependent field that must be included alongside the target field's value, used when the target field's valid options depend on another field (for example, Pipeline requires Stage). Supports nesting up to 3 levels. Additional keys: not allowed
dependent_fields	array	Optional	Nested dependent fields that must be set when the current dependent field itself has further dependencies. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item, Get Field Update By Id — response body — field updates field updates item field

Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	Second-level dependent field in a chained dependency. Example: Stage in a Pipeline -> Stage chain. Additional keys: not allowed
dependent_fields	array	Optional	Third-level dependent fields for deeper dependency chains. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item dependent fields item
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item dependent fields item, Get Field Update By Id — response body — field updates field updates item field

Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	Third-level (deepest) dependent field in a chained dependency. No further nesting is supported beyond this level. Additional keys: not allowed
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Get Field Update By Id — response body — field updates field updates item field

Get Field Update By Id — response body — field updates field updates item field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the target field to update. Requires both id and api_name; if they refer to different fields, the request fails with AMBIGUITY_DURING_PROCESSING. Additional keys: not allowed
api_name	string	Required within parent	API name of the CRM field (e.g., Deal_Name, Pipeline, Owner, Layout, Multi_Select_1). Maximum length: 255
data_type	string	Optional	Data type of the CRM field, for example text, picklist, or lookup. Maximum length: 255
field_label	string	Optional	Display label of the CRM field, as shown in the CRM UI. Maximum length: 255
id	string	Required within parent	Unique identifier of the CRM field. Mandatory in create/update payloads. Maximum length: 255
ui_type	JSON	Optional
ui_type (anyOf 1)	integer	Alternative	Internal UI type code for the field. Present only in response; not required in requests. Format: int32
ui_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Field Update By Id — response body — field updates field updates item lock status

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether a particular component is locked, affecting its editability and deletability. Additional keys: not allowed
locked	boolean	Optional	True when the action is locked and cannot be edited or deleted.

Get Field Update By Id — response body — field updates field updates item modified by

Field	Type	Presence	Description and constraints
$	object	Root	User who last modified the field update action, including display name and unique identifier. Additional keys: not allowed
id	string	Optional	Unique identifier of the user who last modified the resource. Maximum length: 255
name	string	Optional	Display name of the user who last modified the resource. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item related module

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed
$ (anyOf 1).api_name	string	Optional	CRM related-module API name used in automation configuration (e.g., Notes). Maximum length: 255
$ (anyOf 1).id	string	Optional	Unique identifier of the related CRM module corresponding to api_name. Maximum length: 255
$ (anyOf 2)	null	Alternative	Related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed
$ (anyOf 2).api_name	string	Optional	CRM related-module API name used in automation configuration (e.g., Notes). Maximum length: 255
$ (anyOf 2).id	string	Optional	Unique identifier of the related CRM module corresponding to api_name. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item related records null item

Field	Type	Presence	Description and constraints
$	object	Root	Identifies a related module whose open records' ownership should be transferred alongside the parent record when the Owner field is updated. Available modules depend on the parent module context. Additional keys: not allowed
api_name	string	Required within parent	API name of the related module. Events, Calls, Tasks - open activity records, available for all modules. Contacts - available only when the parent module is Accounts. Deals - available when the parent module is Accounts or Contacts. Known values: Events, Calls, Tasks, Contacts, Deals Maximum length: 255
id	string	Optional	Unique identifier of the related module. This is the module ID corresponding to the api_name. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item update type

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields. Known values: overwrite, append Maximum length: 255
$ (anyOf 2)	null	Alternative	Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields. Known values: overwrite, append Maximum length: 255

Get Field Updates — response body — field updates, info

Field	Type	Presence	Description and constraints
$	object	Root	Successful response for listing field update actions. Contains an array of field update definitions configured in the org along with pagination metadata. Additional keys: not allowed
field_updates	array	Optional	List of field update actions configured in the org. Maximum items: 200
field_updates[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item
info	Model	Optional	Expand Get Field Updates — response body — field updates, info info

Referenced models: Get Field Update By Id — response body — field updates field updates item, Get Field Updates — response body — field updates, info info

Get Field Updates — response body — field updates, info info

Field	Type	Presence	Description and constraints
$	object	Root	Pagination metadata for list responses. Use more_records to determine if additional pages are available. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Number of records returned in the current page. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	True when additional records are available on subsequent pages.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Current page number (starts at 1). Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Maximum number of records returned per page (default 200). Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

To delete multiple field update actions — response body — field updates field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a field update ID deleted successfully in bulk delete. Additional keys: not allowed
code	string	Required within parent	Result code. Known values: SUCCESS
details	Model	Required within parent	Expand To delete multiple field update actions — response body — field updates field updates item details
message	string	Required within parent	Success message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: success

Referenced models: To delete multiple field update actions — response body — field updates field updates item details

To delete multiple field update actions — response body — field updates field updates item details

Field	Type	Presence	Description and constraints
$	object	Root	Identifier details for a bulk-delete result item. Additional keys: not allowed
id	string	Required within parent	Field update ID for which this result applies. Maximum length: 20

To delete multiple field update actions — response body — field updates — Bulk Delete Mixed Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete partial-success response. Contains mixed success and failure items for the requested field update IDs. Additional keys: not allowed
field_updates	array	Required within parent	Per-ID deletion results for the bulk request. Maximum items: 10
field_updates[]	JSON	Each item
field_updates[] (anyOf 1)	Model	Alternative	Expand To delete multiple field update actions — response body — field updates field updates item
field_updates[] (anyOf 2)	Model	Alternative	Expand To delete multiple field update actions — response body — field_updates / field_updates / item / code: INVALID DATA, NOT ALLOWED, status: error

Referenced models: To delete multiple field update actions — response body — field_updates / field_updates / item / code: INVALID DATA, NOT ALLOWED, status: error, To delete multiple field update actions — response body — field updates field updates item

To delete multiple field update actions — response body — field updates — Bulk Delete Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete success response where all requested field update IDs are deleted. Additional keys: not allowed
field_updates	array	Required within parent	Deletion result entries for each requested ID. Maximum items: 10
field_updates[]	Model	Each item	Expand To delete multiple field update actions — response body — field updates field updates item

Referenced models: To delete multiple field update actions — response body — field updates field updates item

To delete multiple field update actions — response body — field_updates / field_updates / item / code: INVALID DATA, NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a field update ID that failed during bulk delete. INVALID_DATA indicates the ID does not exist; NOT_ALLOWED indicates the field update is associated with a workflow rule, blueprint, or approval process. Additional keys: not allowed
code	string	Required within parent	Failure code. Known values: INVALID_DATA, NOT_ALLOWED
details	Model	Required within parent	Expand To delete multiple field update actions — response body — field updates field updates item details
message	string	Required within parent	Failure message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: error

Referenced models: To delete multiple field update actions — response body — field updates field updates item details

Update Field Update — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response payload returned after a field update action is modified. Additional keys: not allowed
field_updates	array	Optional	Array containing the updated field update action. Contains exactly one item. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — response body — field updates item

Referenced models: Create Field Update — response body — field updates item