Zoho: Timelines schemas

← Timelines operations · All schemas

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Approval Process details associated with the timeline entry. Additional keys: not allowed
approver_details	object	Optional	Represents the details of the approver who acted on the Approval Process. Additional keys: not allowed
approver_details.id	string	Optional	Represents the unique ID of the approver user. Maximum length: 255
approver_details.name	string	Optional	Represents the name of the approver user. Maximum length: 255
comments	string	Optional	Represents the comments added during the Approval Process action. Maximum length: 1000
current_stage	JSON	Optional
current_stage (anyOf 1)	integer	Alternative	Represents the current stage number of the Approval Process at the time of the timeline event. Format: int32
current_stage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
delegate_details	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process delegate details
next_approver	array	Optional	Represents an array of the next approvers in the Approval Process sequence. Maximum items: 50
next_approver[]	object	Each item	Represents a single next approver in the Approval Process. Additional keys: not allowed
next_approver[].id	string	Optional	Represents the unique ID of the next approver user. Maximum length: 255
next_approver[].name	string	Optional	Represents the name of the next approver user. Maximum length: 255
rejected_details	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process rejected details
takeover_reason	string	Optional	Represents the reason provided for the approval task takeover. Maximum length: 255
takeover_stage	string	Optional	Represents the approval stage at which the takeover occurred. Maximum length: 255

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process delegate details, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process rejected details

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process delegate details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the delegation details when the approval task was delegated from one user to another. Additional keys: not allowed
from	object	Optional	Represents the user from whom the approval task was delegated. Additional keys: not allowed
from.id	string	Optional	Represents the unique ID of the user from whom the approval task was delegated. Maximum length: 255
from.name	string	Optional	Represents the name of the user from whom the approval task was delegated. Maximum length: 255
to	object	Optional	Represents the user to whom the approval task was delegated. Additional keys: not allowed
to.id	string	Optional	Represents the unique ID of the user to whom the approval task was delegated. Maximum length: 255
to.name	string	Optional	Represents the name of the user to whom the approval task was delegated. Maximum length: 255

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process rejected details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the rejection event in the Approval Process. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the user who rejected the approval request. Maximum length: 255
name	string	Optional	Represents the name of the user who rejected the approval request. Maximum length: 255
stage	object	Optional	Represents the stage transition details at the time of rejection. Additional keys: not allowed
stage.from	string	Optional	Represents the approval stage from which the rejection occurred. Maximum length: 255
stage.to	string	Optional	Represents the approval stage to which the process moved after rejection. Maximum length: 255

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the ownership change details recorded in the timeline entry, including previous and new owner information. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the owner user. Maximum length: 255
name	string	Optional	Represents the name of the owner user. Maximum length: 255
new	object	Optional	Represents the new owner assigned to the record after the ownership change. Additional keys: not allowed
new.id	string	Optional	Represents the unique ID of the new owner user. Maximum length: 255
new.name	string	Optional	Represents the name of the new owner user. Maximum length: 255
old	object	Optional	Represents the previous owner of the record before the ownership change. Additional keys: not allowed
old.id	string	Optional	Represents the unique ID of the previous owner user. Maximum length: 255
old.name	string	Optional	Represents the name of the previous owner user. Maximum length: 255

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Blueprint process details associated with the timeline entry, including the triggered state and entry or exit flags. Additional keys: not allowed
process_entry	boolean	Optional	Indicates whether the Blueprint process entry action was triggered for this timeline event.
process_exit	boolean	Optional	Indicates whether the Blueprint process exit action was triggered for this timeline event.
state	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder state

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder state

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder state

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Blueprint state associated with the timeline event. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the Blueprint state. Maximum length: 255
is_last_state	boolean	Optional	Indicates whether this Blueprint state is the final state in the process.
name	string	Optional	Represents the name of the Blueprint state. Maximum length: 255
trigger_type	string	Optional	Represents the trigger type that caused the Blueprint state to activate. Maximum length: 255

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process

Field	Type	Presence	Description and constraints
$	object	Root	Represents the review process details associated with the timeline entry. Additional keys: not allowed
deactivated_process	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process deactivated process
deluge	object	Optional	Represents the Deluge script associated with the review process event. Additional keys: not allowed
deluge.id	string	Optional	Represents the unique ID of the Deluge script. Maximum length: 255
deluge.name	string	Optional	Represents the name of the Deluge script. Maximum length: 255
rejection	object	Optional	Represents the rejection details when the review process was rejected. Additional keys: not allowed
rejection.comment	string	Optional	Represents the comment provided with the rejection. Maximum length: 255
rejection.reason	string	Optional	Represents the reason provided for the rejection. Maximum length: 255

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process deactivated process

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process deactivated process

Field	Type	Presence	Description and constraints
$	object	Root	Represents the process that was deactivated as part of the review process event. Additional keys: not allowed
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique ID of the deactivated process. This field is nullable. Maximum length: 255
id (anyOf 2)	null	Alternative	Represents the unique ID of the deactivated process. This field is nullable. Maximum length: 255
name	string	Optional	Represents the name of the deactivated process. Maximum length: 255

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Scoring Rule details associated with the timeline entry, including score changes for positive and negative scoring and touchpoint scoring. Additional keys: not allowed
negative_score	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule negative score
positive_score	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule positive score
touch_point	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point
zia_type	boolean	Optional	Indicates whether the Scoring Rule event was triggered by Zia, the AI assistant in Zoho CRM.

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule negative score, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule positive score, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule negative score

Field	Type	Presence	Description and constraints
$	object	Root	Represents the negative score change recorded for the record by the Scoring Rule. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new negative score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
new (anyOf 2)	null	Alternative	Represents the new negative score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous negative score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20
old (anyOf 2)	null	Alternative	Represents the previous negative score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule positive score

Field	Type	Presence	Description and constraints
$	object	Root	Represents the positive score change recorded for the record by the Scoring Rule. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new positive score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
new (anyOf 2)	null	Alternative	Represents the new positive score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous positive score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20
old (anyOf 2)	null	Alternative	Represents the previous positive score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point

Field	Type	Presence	Description and constraints
$	object	Root	Represents the touchpoint score details associated with the Scoring Rule event. Additional keys: not allowed
negative_score	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point negative score
positive_score	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point positive score
score	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point score

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point negative score, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point positive score, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point score

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point negative score

Field	Type	Presence	Description and constraints
$	object	Root	Represents the touchpoint negative score change recorded by the Scoring Rule. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new touchpoint negative score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
new (anyOf 2)	null	Alternative	Represents the new touchpoint negative score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous touchpoint negative score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20
old (anyOf 2)	null	Alternative	Represents the previous touchpoint negative score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point positive score

Field	Type	Presence	Description and constraints
$	object	Root	Represents the touchpoint positive score change recorded by the Scoring Rule. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new touchpoint positive score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
new (anyOf 2)	null	Alternative	Represents the new touchpoint positive score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous touchpoint positive score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20
old (anyOf 2)	null	Alternative	Represents the previous touchpoint positive score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule touch point score

Field	Type	Presence	Description and constraints
$	object	Root	Represents the overall touchpoint score change recorded by the Scoring Rule. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new overall touchpoint score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
new (anyOf 2)	null	Alternative	Represents the new overall touchpoint score value after the Scoring Rule was applied. This field is nullable. Maximum length: 20
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous overall touchpoint score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20
old (anyOf 2)	null	Alternative	Represents the previous overall touchpoint score value before the Scoring Rule was applied. This field is nullable. Maximum length: 20

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow workflow

Field	Type	Presence	Description and constraints
$	object	Root	Represents the workflow details associated with the timeline entry. Additional keys: not allowed
field_update_action	array	Optional	Represents an array of field update actions executed by the workflow. Maximum items: 50
field_update_action[]	object	Each item	Represents a single field update action executed by the workflow. Additional keys: not allowed
field_update_action[].id	string	Optional	Represents the unique ID of the workflow field update action. Maximum length: 255
field_update_action[].name	string	Optional	Represents the name of the workflow field update action. Maximum length: 255

Get Timelines — response body — timeline, info timeline item extension id, namespace, signal signal

Field	Type	Presence	Description and constraints
$	object	Root	Represents the signal details dispatched by the extension. Additional keys: not allowed
action	string	Optional	Represents the action performed by the extension signal. Maximum length: 255
display_label	string	Optional	Represents the display label shown for the extension signal in the CRM timeline. Maximum length: 255
id	string	Optional	Represents the unique ID of the extension signal. Maximum length: 255
medium	string	Optional	Represents the medium through which the extension signal was generated. Maximum length: 255

Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single field change recorded in the timeline event. Additional keys: not allowed
_value	Model	Optional	Expand Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item value
api_name	string	Optional	Represents the API name of the field that changed. Maximum length: 255
data_type	string	Optional	Represents the data type of the field that changed. Maximum length: 255
enable_colour_code	boolean	Optional	Indicates whether color coding is enabled for the changed field's values.
field_label	string	Optional	Represents the display label of the field that changed. Maximum length: 255
id	string	Optional	Represents the unique ID of the changed field. Maximum length: 255
pick_list_values	array	Optional	Represents an array of picklist options for the changed field, applicable when the field is a picklist type. Maximum items: 200
pick_list_values[]	Model	Each item	Expand Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item pick list values item

Referenced models: Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item pick list values item, Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item value

Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single picklist option for the changed field. Additional keys: not allowed
actual_value	string	Optional	Represents the actual stored value of the picklist option. Maximum length: 255
colour_code	JSON	Optional
colour_code (anyOf 1)	string	Alternative	Represents the color code associated with the picklist option. This field is nullable. Maximum length: 255
colour_code (anyOf 2)	null	Alternative	Represents the color code associated with the picklist option. This field is nullable. Maximum length: 255
display_value	string	Optional	Represents the display text of the picklist option shown in the CRM interface. Maximum length: 255
id	string	Optional	Represents the unique ID of the picklist option. Maximum length: 255
reference_value	string	Optional	Represents the reference value of the picklist option, used for lookups and cross-references. Maximum length: 255
sequence_number	JSON	Optional
sequence_number (anyOf 1)	integer	Alternative	Represents the sequence number that determines the display order of the picklist option. Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Optional	Represents the type of the picklist option. Maximum length: 255

Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the old and new values for the changed field. Additional keys: not allowed
new	JSON	Optional
new (anyOf 1)	string	Alternative	Represents the new value of the field after the change. This field is nullable. Maximum length: 255
new (anyOf 2)	null	Alternative	Represents the new value of the field after the change. This field is nullable. Maximum length: 255
old	JSON	Optional
old (anyOf 1)	string	Alternative	Represents the previous value of the field before the change. This field is nullable. Maximum length: 255
old (anyOf 2)	null	Alternative	Represents the previous value of the field before the change. This field is nullable. Maximum length: 255

Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_2b0dda6c2f47

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module information for the related CRM record. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the module containing the related CRM record. Maximum length: 255
id	string	Optional	Represents the unique ID of the module containing the related CRM record. Maximum length: 255
name	string	Optional	Represents the display name of the module containing the related CRM record. Maximum length: 255

Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_633d561b2023

Field	Type	Presence	Description and constraints
$	null	Root	Represents the module information for the related CRM record. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the module containing the related CRM record. Maximum length: 255
id	string	Optional	Represents the unique ID of the module containing the related CRM record. Maximum length: 255
name	string	Optional	Represents the display name of the module containing the related CRM record. Maximum length: 255