Zoho: Assignment rules schemas

← Assignment rules operations · All schemas

Assignment Rule Associations — response body — associations

Field	Type	Presence	Description and constraints
$	object	Root	Contains the response structure for Assignment Rule association details. Additional keys: not allowed
associations	array	Optional	Contains the CRM features associated with the Assignment Rule. Maximum items: 200 Minimum items: 1
associations[]	Model	Each item	Expand Assignment Rule Associations — response body — associations associations item

Referenced models: Assignment Rule Associations — response body — associations associations item

Assignment Rule Associations — response body — associations associations item

Field	Type	Presence	Description and constraints
$	object	Root	List of features in which Assignment Rule is associated. Additional keys: not allowed
resources	array	Optional	Represents the list of features in which Assignment Rule is associated. Maximum items: 1
resources[]	Model	Each item	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
type	string	Optional	Represents the type returned for the Assignment Rule operation. Maximum length: 255

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Assignment Rules Count — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the count returned for the Assignment Rule operation. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Assignment Rules — response body — Get all Assignment Rules success response

Field	Type	Presence	Description and constraints
$	object	Root	Get all Assignment Rules success response. Additional keys: not allowed
assignment_rules	array	Optional	Represents the list of all Assignment Rules. Maximum items: 200 Minimum items: 1
assignment_rules[]	Model	Each item	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the Assignment Rule. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the rule. Maximum length: 100 Minimum length: 1
created_by	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
created_time	string	Required within parent	Represents the date and time of Assignment Rule creation. Format: date-time Maximum length: 255
default_assignee	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item default assignee Defines the details of the fall back user to whom the records will be assigned when owner couldn't be assigned by any of the rule entries defined. (Required)
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Purpose of the Assignment Rule. Maximum length: 250
description (anyOf 2)	null	Alternative	Purpose of the Assignment Rule. Maximum length: 250
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
modified_by	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
modified_time	string	Required within parent	Represents the date and time of Assignment Rule recent modification. Format: date-time Maximum length: 255
module	Model	Optional	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
name	string	Required within parent	Represents the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item default assignee, Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item default assignee

Field	Type	Presence	Description and constraints
$	object	Root	Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries. Additional keys: not allowed
id	JSON	Optional	Represents the iD of the default assignee. is deprecated.
id (anyOf 1)	string	Alternative	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
id (anyOf 2)	string	Alternative	To define "logged in user" as fallback user for the given Assignment Rule, set ${CURRENTUSER} as value for this field. Known values: ${CURRENTUSER}
name	string	Optional	Represents the display name of the default assignee. Maximum length: 255
resource	JSON	Optional	Represents the resource returned for the Assignment Rule operation.
resource (anyOf 1)	Model	Alternative	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module Defines the details of the default assignee
resource (anyOf 2)	JSON	Alternative	Defines the details of the default assignee. Additional keys: not allowed
resource (anyOf 2).api_name	string	Optional	To define "logged in user" as fallback user for the given Assignment Rule, set ${CURRENTUSER} as value for this field. Possible values: **${CURRENTUSER}** - Represents ${currentuser}. Known values: ${CURRENTUSER}
resource (anyOf 2).name	string	Optional	Logged in user reference display name. Maximum length: 255
type	string	Optional	Defines the type of the default assignee. Possible values: **user** - Represents user. Known values: user

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Resource details. Additional keys: allowed
_details	Model	Optional	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details
api_name	string	Optional	Represents the API name of the resource. Maximum length: 255
id	string	Required within parent	ID of the resource. Id of the resource Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
name	string	Required within parent	Represents the display name of the resource. Maximum length: 255
zuid	string	Optional	Zuid of the user resource Format: int32 Maximum length: 19

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	null	Alternative	_Details Schema. Additional keys: allowed
$ (anyOf 2)	object	Alternative	_Details Schema. Additional keys: allowed

Clone Assignment Rule Entries — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the request structure for cloning rule entries in an Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Specify the **assignment_rules** array that contains the rule entries to clone into the target Assignment Rule. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rule object that contains the rule entries to clone. Additional keys: not allowed
assignment_rules[].rule_entries	array	Required within parent	Specify the list of rule entries to clone while retaining their order and configuration in the target Assignment Rule. Maximum items: 1 Minimum items: 1
assignment_rules[].rule_entries[]	Model	Each item	Expand Clone Assignment Rule Entries — request body — body assignment rules item rule entries item

Referenced models: Clone Assignment Rule Entries — request body — body assignment rules item rule entries item

Clone Assignment Rule Entries — request body — body assignment rules item rule entries item

Field	Type	Presence	Description and constraints
$	object	Root	Rule entry request object to update. Additional keys: not allowed
allow_agent_user	boolean	Optional	Indicates whether Digital Employee (agent) users are eligible for assignment in this rule entry.
assign_to	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item assign to This field defines the set of users to whom the records that enter the current rule entry must be assigned. (Required)
criteria	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item criteria Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry's assignment logic.
followup_actions	array or null	Optional	Defines the list of different actions to be executed after owner assignment. Maximum items: 1 Minimum items: 1
followup_actions[]	Model	Each item	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
user_availability_based_on	array or null	Optional	Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2
user_availability_based_on[]	string	Each item	Specify each user availability based on entry in the Assignment Rule request. Possible values: **online_status** - Represents online status. **shift_timing** - Represents shift timing. One of: online_status, shift_timing

Referenced models: Create an Assignment Rule — request body — body assignment rules item rule entries item assign to, Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item, Create an Assignment Rule — request body — body assignment rules item rule entries item criteria

Clone Assignment Rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for cloning Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Array of Assignment Rule objects to be created. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rules entry in the Assignment Rule request. Additional keys: not allowed
assignment_rules[].name	string	Required within parent	Specify the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1

Clone Assignment Rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Successful API operation completed. Additional keys: not allowed
assignment_rules	array	Optional	Represents the Assignment Rules returned for the Assignment Rule operation. Maximum items: 1 Minimum items: 1
assignment_rules[]	Model	Each item	Expand Clone Assignment Rule — response body — assignment rules item details of assignment rule created/cloned/updated/deleted

Referenced models: Clone Assignment Rule — response body — assignment rules item

Clone Assignment Rule — response body — assignment rules item

Field	Type	Presence	Description and constraints
$	object	Root	Details of successfully created/cloned/deleted/updated Assignment Rules, including code, message, and status. Additional keys: not allowed
code	string	Optional	Represents the status code that identifies the result of the Assignment Rule operation. Possible values: **SUCCESS** - Represents success. Known values: SUCCESS
details	Model	Optional	Expand Clone Assignment Rule — response body — assignment rules item details
message	string	Optional	Represents the message that describes the result of the Assignment Rule operation. Maximum length: 255
status	string	Optional	Represents the status of the Assignment Rule operation. Possible values: **success** - Represents success. Known values: success

Referenced models: Clone Assignment Rule — response body — assignment rules item details

Clone Assignment Rule — response body — assignment rules item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents additional details about the Assignment Rule operation result. Additional keys: not allowed
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
rule_entries	array	Optional	Represents the rule entries returned for the Assignment Rule operation. Maximum items: 200 Minimum items: 1
rule_entries[]	object	Each item	Represents each rule entries entry returned for the Assignment Rule operation. Additional keys: not allowed
rule_entries[].id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for creating Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Array of Assignment Rule objects to be created. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rules entry in the Assignment Rule request. Additional keys: not allowed
assignment_rules[].api_name	string	Optional	Specify the aPI name of the rule. Maximum length: 100 Minimum length: 1
assignment_rules[].default_assignee	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item default assignee
assignment_rules[].description	string	Optional	Purpose of the Assignment Rule. Maximum length: 250
assignment_rules[].name	string	Required within parent	Specify the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1
assignment_rules[].rule_entries	array	Required within parent	Specify the list of rule entries for creation. Maximum items: 200 Minimum items: 1
assignment_rules[].rule_entries[]	Model	Each item	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item

Referenced models: Create an Assignment Rule — request body — body assignment rules item default assignee, Create an Assignment Rule — request body — body assignment rules item rule entries item

Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user

Field	Type	Presence	Description and constraints
$	object	Root	Configures a specific user or the currently logged-in user as the default assignee. Additional keys: not allowed
resource	JSON	Required within parent	Specify the resource for the Assignment Rule request.
resource (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry Specific user to set as the default assignee
resource (anyOf 2)	object	Alternative	Defines the logged-in user as the default assignee. Additional keys: not allowed
resource (anyOf 2).api_name	string	Optional	Set ${CURRENTUSER} to use the logged-in user as the default assignee. Possible values: **${CURRENTUSER}** - Represents ${currentuser}. One of: ${CURRENTUSER}
type	string	Required within parent	Default assignee type. Must be 'user'. Possible values: **user** - Represents user. One of: user

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry

Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry

Field	Type	Presence	Description and constraints
$	object	Root	User resource reference for Assignment Rule entry. Additional keys: not allowed
id	string	Required within parent	Specify the iD of the user. Refer to the [Users API](users.yaml#$.paths./users.get) resource for valid values. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: criteria

Field	Type	Presence	Description and constraints
$	object	Root	Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. Additional keys: not allowed
criteria	object or null	Required within parent	Defines the criteria of the users who is considered for owner assignment for records entering the current rule entry. Additional keys: allowed
type	string	Required within parent	Defines which set of users should be considered for assignment. Possible values: **criteria** - Represents criteria. One of: criteria Maximum length: 255

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group

Field	Type	Presence	Description and constraints
$	object	Root	Assigns ownership to a group. All users within the specified group are eligible for assignment. Additional keys: not allowed
resource	Model	Required within parent	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group resource Details of the group to assign
type	string	Required within parent	Assign to type IDentifier. Must be 'group'. Possible values: **group** - Represents group. One of: group

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group resource

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group resource

Field	Type	Presence	Description and constraints
$	object	Root	Group resource reference for Assignment Rule entry. Additional keys: not allowed
id	string	Required within parent	Specify the ID of the group. Refer to the [User Groups](user_groups.yaml#$.paths./settings/user_groups.get) resource for valid values. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile

Field	Type	Presence	Description and constraints
$	object	Root	Assigns ownership to a profile. All users under the specified profile are eligible for assignment. Additional keys: not allowed
resource	Model	Required within parent	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile resource Details of the profile to assign
type	string	Required within parent	Assign to type IDentifier. Must be 'profile'. Possible values: **profile** - Represents profile. One of: profile

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile resource

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile resource

Field	Type	Presence	Description and constraints
$	object	Root	Profile resource reference for Assignment Rule entry. Additional keys: not allowed
id	string	Required within parent	Specify the iD of the profile. Refer to the [Profiles API](profiles.yaml#$.paths./settings/profiles.get) resource for valid values. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role

Field	Type	Presence	Description and constraints
$	object	Root	Assigns ownership to a role. All users under the specified role are eligible for assignment. Additional keys: not allowed
resource	Model	Required within parent	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role resource Details of the role to assign
type	string	Required within parent	Assign to type IDentifier. Must be 'role'. Possible values: **role** - Represents role. One of: role

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role resource

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role resource

Field	Type	Presence	Description and constraints
$	object	Root	Role resource reference for Assignment Rule entry. Additional keys: not allowed
id	string	Required within parent	Specify the iD of the role. Refer to the [Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: users

Field	Type	Presence	Description and constraints
$	object	Root	Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. Additional keys: not allowed
resources	array	Required within parent	Defines the list of users details. Maximum items: 50 Minimum items: 1
resources[]	Model	Each item	Expand Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry
type	string	Required within parent	If assign to type is users. Possible values: **users** - Represents users. One of: users

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users

Field	Type	Presence	Description and constraints
$	object	Root	Assigns ownership using Zia AI suggestions. No resource configuration needed. Additional keys: not allowed
type	string	Required within parent	Assign to type IDentifier. Must be 'zia_suggested_users'. Possible values: **zia_suggested_users** - Represents zia suggested users. One of: zia_suggested_users

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks

Field	Type	Presence	Description and constraints
$	object	Root	Followup action that creates a task after ownership assignment. Additional keys: not allowed
resources	array	Optional	Specify the list of task resources to execute as followup. Maximum items: 1 Minimum items: 1
resources[]	Model	Each item	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks resources item
type	string	Required within parent	Followup action type. Must be 'tasks'. Possible values: **tasks** - Represents tasks. One of: tasks

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks resources item

Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks resources item

Field	Type	Presence	Description and constraints
$	object	Root	Task resource reference for followup action. Additional keys: not allowed
id	string	Required within parent	Specify the iD of the task. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Create an Assignment Rule — request body — body assignment rules item default assignee

Field	Type	Presence	Description and constraints
$	JSON	Root	Fallback assignee when no rule entry matches. Currently supports user type. Additional types (for example, queue) may be added in future versions.
$ (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user

Create an Assignment Rule — request body — body assignment rules item rule entries item

Field	Type	Presence	Description and constraints
$	object	Root	Defines entries with matching and assignment logic for record processing. Additional keys: not allowed
assign_to	Model	Required within parent	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item assign to This field defines the set of users to whom the records that enter the current rule entry must be assigned. (Required)
criteria	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item criteria Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry's assignment logic.
followup_actions	array or null	Optional	Defines the list of different actions to be executed after owner assignment. Maximum items: 1 Minimum items: 1
followup_actions[]	Model	Each item	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item
user_availability_based_on	array or null	Optional	Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2
user_availability_based_on[]	string	Each item	Specify each user availability based on entry in the Assignment Rule request. Possible values: **online_status** - Represents online status. **shift_timing** - Represents shift timing. One of: online_status, shift_timing

Referenced models: Create an Assignment Rule — request body — body assignment rules item rule entries item assign to, Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item, Create an Assignment Rule — request body — body assignment rules item rule entries item criteria

Create an Assignment Rule — request body — body assignment rules item rule entries item assign to

Field	Type	Presence	Description and constraints
$	JSON	Root	Assign to request object schema.
$ (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users
$ (anyOf 2)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role
$ (anyOf 3)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group
$ (anyOf 4)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile
$ (anyOf 5)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: users
$ (anyOf 6)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: criteria

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: criteria, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: users, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users

Create an Assignment Rule — request body — body assignment rules item rule entries item criteria

Field	Type	Presence	Description and constraints
$	JSON	Root	Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators. Additional keys: allowed
$ (anyOf 1)	Model	Alternative	Expand Related Records — request body — query filters
$ (anyOf 2)	null	Alternative	To remove criteria from an existing rule entry, set criteria as null in update request.

Referenced models: Related Records — request body — query filters

Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item

Field	Type	Presence	Description and constraints
$	JSON	Root	Followup action to execute after ownership assignment. Currently supports tasks. Additional types may be added in future versions.
$ (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks

Reorder Assignment Rule entries — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for reordering entries of an Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Array of Assignment Rule objects to be created. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rules entry in the Assignment Rule request. Additional keys: not allowed
assignment_rules[].rule_entries	array	Required within parent	Specify the list of rule entries with updated sequence number for reordering. Maximum items: 200 Minimum items: 1
assignment_rules[].rule_entries[]	Model	Each item	Expand Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Referenced models: Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Field	Type	Presence	Description and constraints
$	object	Root	Rule entry request object to delete. Additional keys: not allowed
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
sequence_number	integer	Required within parent	Entry order of the rule entry. This property can be updated only using reorder_entries API. Format: int32

Specific Assignment Rule details — response body — Get all Assignment Rules success response

Field	Type	Presence	Description and constraints
$	object	Root	Get all Assignment Rules success response. Additional keys: not allowed
assignment_rules	array	Optional	Represents the list of all Assignment Rules. Maximum items: 1 Minimum items: 1
assignment_rules[]	Model	Each item	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item

Referenced models: Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item

Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: criteria

Field	Type	Presence	Description and constraints
$	object	Root	Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. Additional keys: not allowed
criteria	JSON	Required within parent
criteria (anyOf 1)	object	Alternative	Defines the criteria of the users who is considered for owner assignment for records entering the current rule entry. Additional keys: allowed
criteria (anyOf 2)	null	Alternative	Defines the criteria of the users who is considered for owner assignment for records entering the current rule entry. Additional keys: allowed
type	string	Required within parent	Defines which set of users should be considered for assignment. Possible values: **criteria** - Represents criteria. Known values: criteria Maximum length: 255

Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: role, group, profile

Field	Type	Presence	Description and constraints
$	object	Root	Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. Additional keys: not allowed
resource	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module Defines the details user category such as role, group, profile
type	string	Required within parent	Defines which set of users should be considered for assignment. Possible values: **role** - Represents role. **group** - Represents group. **profile** - Represents profile. Known values: role, group, profile

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: users

Field	Type	Presence	Description and constraints
$	object	Root	Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. Additional keys: not allowed
resources	array	Required within parent	Defines the list of users details. Maximum items: 50 Minimum items: 1
resources[]	Model	Each item	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
type	string	Required within parent	If assign to type is users. Possible values: **users** - Represents users. Known values: users

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users

Field	Type	Presence	Description and constraints
$	object	Root	If assign to type is zia suggested user. Additional keys: not allowed
type	string	Required within parent	Defines the type or users to associate as owner during execution. Possible values: **zia_suggested_users** - Represents zia suggested users. Known values: zia_suggested_users

Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the Assignment Rule. Additional keys: not allowed
api_name	string	Required within parent	Represents the aPI name of the rule. Maximum length: 100 Minimum length: 1
created_by	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
created_time	string	Required within parent	Represents the date and time of Assignment Rule creation. Format: date-time Maximum length: 255
default_assignee	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item default assignee Defines the details of the fall back user to whom the records will be assigned when owner couldn't be assigned by any of the rule entries defined. (Required)
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Purpose of the Assignment Rule. Maximum length: 250
description (anyOf 2)	null	Alternative	Purpose of the Assignment Rule. Maximum length: 250
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
modified_by	Model	Required within parent	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
modified_time	string	Required within parent	Represents the date and time of Assignment Rule recent modification. Format: date-time Maximum length: 255
module	Model	Optional	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
name	string	Required within parent	Represents the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1
rule_entries	array	Required within parent	Defines the list of rules entries with record matching logic and assignment logic. Maximum items: 200
rule_entries[]	Model	Each item	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item default assignee, Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module, Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item

Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item

Field	Type	Presence	Description and constraints
$	object	Root	Defines entries with matching and assignment logic for record processing. Additional keys: not allowed
allow_agent_user	boolean	Optional	Indicates whether Digital Employee (agent) users are eligible for assignment in this rule entry.
assign_to	Model	Required within parent	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item assign to
criteria	JSON	Required within parent
criteria (anyOf 1)	object	Alternative	Defines the record criteria based on which records is filtered and assignment logic defined for current rule entry is applied. If criteria is not provided or is null, all records entering current rule entry is assigned based on current rule entry's assignment logic. Additional keys: allowed
criteria (anyOf 2)	null	Alternative	Defines the record criteria based on which records is filtered and assignment logic defined for current rule entry is applied. If criteria is not provided or is null, all records entering current rule entry is assigned based on current rule entry's assignment logic. Additional keys: allowed
followup_actions	JSON	Required within parent
followup_actions (anyOf 1)	array	Alternative	Defines the list of different actions to be executed after owner assignment. Maximum items: 1 Minimum items: 1
followup_actions (anyOf 1)[]	Model	Each item	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item followup actions null item
followup_actions (anyOf 2)	null	Alternative	Defines the list of different actions to be executed after owner assignment. Maximum items: 1 Minimum items: 1
followup_actions (anyOf 2)[]	Model	Each item	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item followup actions null item
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
sequence_number	JSON	Required within parent
sequence_number (anyOf 1)	integer	Alternative	Represents the sequence number returned for the Assignment Rule operation. Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
user_availability_based_on	JSON	Required within parent
user_availability_based_on (anyOf 1)	array	Alternative	Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2
user_availability_based_on (anyOf 1)[]	string	Each item	Represents each user availability based on entry returned for the Assignment Rule operation. Possible values: **online_status** - Represents online status. **shift_timing** - Represents shift timing. Known values: online_status, shift_timing
user_availability_based_on (anyOf 2)	null	Alternative	Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2
user_availability_based_on (anyOf 2)[]	string	Each item	Represents each user availability based on entry returned for the Assignment Rule operation. Possible values: **online_status** - Represents online status. **shift_timing** - Represents shift timing. Known values: online_status, shift_timing

Referenced models: Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item assign to, Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item followup actions null item

Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item assign to

Field	Type	Presence	Description and constraints
$	JSON	Root	Assign to response object schema.
$ (anyOf 1)	Model	Alternative	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users
$ (anyOf 2)	Model	Alternative	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: users
$ (anyOf 3)	Model	Alternative	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: role, group, profile
$ (anyOf 4)	Model	Alternative	Expand Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: criteria

Referenced models: Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: criteria, Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: role, group, profile, Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: users, Specific Assignment Rule details — response body — Get all Assignment Rules success response / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users

Specific Assignment Rule details — response body — Get all Assignment Rules success response assignment rules item rule entries item followup actions null item

Field	Type	Presence	Description and constraints
$	object	Root	List of actions to be executed following the assignment of ownership to a record. Additional keys: not allowed
resources	array	Optional	Represents the list of action details of the given type. Maximum items: 1 Minimum items: 1
resources[]	Model	Each item	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
type	string	Required within parent	Represents the type of the action. Possible values: **tasks** - Represents tasks. Known values: tasks

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Update a Specific Assignment Rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for creating Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Array of Assignment Rule objects to be created. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rules entry in the Assignment Rule request. Additional keys: not allowed
assignment_rules[].api_name	string	Optional	Specify the aPI name of the rule. Maximum length: 100 Minimum length: 1
assignment_rules[].default_assignee	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item default assignee
assignment_rules[].description	string	Optional	Purpose of the Assignment Rule. Maximum length: 250
assignment_rules[].name	string	Optional	Specify the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1
assignment_rules[].rule_entries	array	Optional	Specify the list of rule entries for creation, update or deletion. To delete an existing rule entry, provide the ID of the rule entry to be deleted and set _delete field as null in the request body. To update an existing rule entry, provide the ID of the rule entry to be updated along with the fields to be updated in the request body. To create a new rule entry, do not provide ID field and provide details of the new rule entry in the request body. Maximum items: 200 Minimum items: 1
assignment_rules[].rule_entries[]	JSON	Each item	Specify each rule entries entry in the Assignment Rule request.
assignment_rules[].rule_entries[] (anyOf 1)	Model	Alternative	Expand Update a Specific Assignment Rule — request body — body assignment rules item rule entries item Rule entry request object to delete
assignment_rules[].rule_entries[] (anyOf 2)	Model	Alternative	Expand Clone Assignment Rule Entries — request body — body assignment rules item rule entries item
assignment_rules[].rule_entries[] (anyOf 3)	Model	Alternative	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item

Referenced models: Create an Assignment Rule — request body — body assignment rules item default assignee, Create an Assignment Rule — request body — body assignment rules item rule entries item, Update a Specific Assignment Rule — request body — body assignment rules item rule entries item Rule entry request object to delete, Clone Assignment Rule Entries — request body — body assignment rules item rule entries item

Update a Specific Assignment Rule — request body — body assignment rules item rule entries item Rule entry request object to delete

Field	Type	Presence	Description and constraints
$	object	Root	Rule entry request object to delete. Additional keys: not allowed
_delete	null	Required within parent	To delete an existing rule entry, provide the ID of the rule entry to be deleted and set _delete field as null in the request body.
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$