Zoho: Territories schemas

← Territories operations · All schemas

Assign territories to a record — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Successful response returned when territories are assigned to a record. Additional keys: not allowed
data	array	Required within parent	Array containing the result of the territory assignment. Maximum items: 1 Minimum items: 1
data[]	object	Each item	Details of the territory assignment operation. Additional keys: not allowed
data[].code	string	Required within parent	Status code indicating the territory assignment was successful. Known values: SUCCESS
data[].details	object	Required within parent	Additional information about the territory assignment. Additional keys: not allowed
data[].details.id	string	Required within parent	Unique identifier of the record. Format: int64
data[].message	string	Required within parent	Success message confirming that the territory data was updated. Known values: the territories data updated successfully, the territories data removed successfully
data[].status	string	Required within parent	Indicates whether the operation succeeded or failed. Known values: success

Assign territories to a record — response body — value data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a single-record territory assignment job has been scheduled. Additional keys: not allowed
data	array	Required within parent	Represents the list of record-territory association objects. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Assign territories to a record — response body — value data data item

Referenced models: Assign territories to a record — response body — value data data item

Assign territories to a record — response body — value data data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a single territory assignment operation. Additional keys: not allowed
code	string	Required within parent	Represents the code for the scheduled territory assignment. Possible values: **SCHEDULED**. Known values: SCHEDULED
details	object	Required within parent	Represents additional details about the scheduled territory assignment, including the record and job identifiers. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the record. Format: int64
details.job_id	string	Required within parent	Represents the unique identifier of the scheduled job. Format: int64
message	string	Required within parent	Represents the message returned when the territory assignment is scheduled. Possible values: **Territory assignment process scheduled successfully**. Known values: Territory assignment process scheduled successfully
status	string	Required within parent	Represents the status of the operation. Possible values: **success**. Known values: success

Assign territories to multiple records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when territories are successfully assigned to records. Additional keys: not allowed
data	array	Required within parent	Represents the list of territory assignment result objects. Maximum items: 10 Minimum items: 1
data[]	object	Each item	Represents the error details for a single territory assignment operation. Additional keys: not allowed
data[].code	string	Required within parent	Represents the result code for the territory assignment. Possible values: **SUCCESS**. Known values: SUCCESS
data[].details	object	Required within parent	Represents additional details about the territory assignment, including the record identifier. Additional keys: not allowed
data[].details.id	string	Required within parent	Represents the unique identifier of the record to which territories were assigned. Format: int64
data[].message	string	Required within parent	Represents the success message returned for the territory assignment. Possible values: **the territories data updated successfully**. Known values: the territories data updated successfully
data[].status	string	Required within parent	Represents the status of the territory assignment operation. Possible values: **success**. Known values: success

Assign territories to multiple records — response body — value data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a territory assignment job has been scheduled. Additional keys: not allowed
data	array	Required within parent	Represents the list of record-territory association objects. Maximum items: 10 Minimum items: 1
data[]	Model	Each item	Expand Assign territories to a record — response body — value data data item

Referenced models: Assign territories to a record — response body — value data data item

Create Territories — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when one or more territories are successfully created. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects created by the request. Maximum items: 100 Minimum items: 1
territories[]	object	Each item	Represents the error details for a single territory creation operation. Additional keys: not allowed
territories[].code	string	Required within parent	Represents the result code for the territory creation. Possible values: **SUCCESS**. Known values: SUCCESS
territories[].details	object	Required within parent	Represents additional details about the created territory, including its unique identifier. Additional keys: not allowed
territories[].details.id	string	Required within parent	Represents the unique identifier of the created territory. Format: int64
territories[].message	string	Required within parent	Represents the success message returned for the territory creation. Possible values: **Territory Created Successfully**. Known values: Territory Created Successfully Maximum length: 100
territories[].status	string	Required within parent	Represents the status of the territory creation operation. Possible values: **success**. Known values: success

Delete territories — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when one or more territories are successfully deleted. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects deleted by the request. Maximum items: 100 Minimum items: 1
territories[]	object	Each item	Represents the error details for a single territory delete operation. Additional keys: not allowed
territories[].code	string	Required within parent	Represents the result code for the territory deletion. Possible values: **SUCCESS**. Known values: SUCCESS
territories[].details	object	Required within parent	Represents additional details about the deleted territory, including its unique identifier. Additional keys: not allowed
territories[].details.id	string	Required within parent	Represents the unique identifier of the deleted territory. Format: int64
territories[].message	string	Required within parent	Represents the success message returned for the territory deletion. Possible values: **Territory Deleted Successfully**, **Given Territory Removed Successfully**. Known values: Territory Deleted Successfully, Given Territory Removed Successfully Maximum length: 100
territories[].status	string	Required within parent	Represents the status of the territory deletion operation. Possible values: **success**. Known values: success

Get all territories — response body — value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the response for the GET /settings/territories endpoint. Returns either a paginated list of territories with an info object, or a filtered list of territories when the ids parameter is provided.
$ (anyOf 1)	object	Alternative	Represents the paginated response containing a list of territories with pagination details. Additional keys: not allowed
$ (anyOf 1).info	Model	Required within parent	Expand Get child territories by parent territory ID — response body — info, territories info Pagination metadata for the response.
$ (anyOf 1).territories	array	Required within parent	Represents the list of territory objects returned in the paginated response. Maximum items: 200 Minimum items: 1
$ (anyOf 1).territories[]	Model	Each item	Expand Get territory by ID — response body — territories territories item Individual territory object containing detailed information about the territory.
$ (anyOf 2)	object	Alternative	Represents the response containing territories filtered by the specified IDs. Additional keys: not allowed
$ (anyOf 2).territories	array	Required within parent	Represents the list of territory objects filtered by the specified IDs. Maximum items: 100 Minimum items: 1
$ (anyOf 2).territories[]	Model	Each item	Expand Get territory by ID — response body — territories territories item Individual territory object.

Referenced models: Get child territories by parent territory ID — response body — info, territories info, Get territory by ID — response body — territories territories item

Get child territories by parent territory ID — response body — info, territories

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing child territories with pagination details. Additional keys: not allowed
info	Model	Required within parent	Expand Get child territories by parent territory ID — response body — info, territories info Pagination metadata for the response.
territories	array	Required within parent	Represents the list of child territory objects. Maximum items: 200 Minimum items: 1
territories[]	Model	Each item	Expand Get territory by ID — response body — territories territories item Individual territory object.

Referenced models: Get child territories by parent territory ID — response body — info, territories info, Get territory by ID — response body — territories territories item

Get child territories by parent territory ID — response body — info, territories info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination details for the response, including the current page, per-page count, total count, and whether more records are available. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of records returned in the current page. Format: int32 Minimum: 0
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Required within parent	Indicates whether more records are available in subsequent pages.
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative	Represents the current page number of the paginated results. Format: int32 Minimum: 1
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Required within parent
per_page (anyOf 1)	integer	Alternative	Represents the number of records returned per page. Format: int32 Maximum: 2000 Minimum: 1
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get scheduled territory run rule job status — response body — scheduled run rule jobs

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the status and details of scheduled territory run rule jobs. Additional keys: not allowed
scheduled_run_rule_jobs	object	Required within parent	Represents the status and details of the scheduled territory rule execution job. Additional keys: not allowed
scheduled_run_rule_jobs.job_id	string	Required within parent	Represents the unique identifier of the scheduled run rule job. Format: int64
scheduled_run_rule_jobs.scheduled_by	object	Required within parent	Represents the user who scheduled the run rule job. Additional keys: not allowed
scheduled_run_rule_jobs.scheduled_by.id	string	Required within parent	Represents the unique identifier of the user who scheduled the run rule job. Format: int64
scheduled_run_rule_jobs.scheduled_by.name	string	Required within parent	Represents the name of the user who scheduled the run rule job. Maximum length: 100
scheduled_run_rule_jobs.scheduled_time	string	Required within parent	Represents the date and time when the run rule job was scheduled, in ISO 8601 format. Format: date-time
scheduled_run_rule_jobs.status	string	Required within parent	Represents the current status of the scheduled run rule job. Possible values: **COMPLETED**, **IN_PROGRESS**, **FAILED**, **SCHEDULED**. Known values: COMPLETED, IN_PROGRESS, FAILED, SCHEDULED

Get territory by ID — response body — territories

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when retrieving a territory by its unique ID. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects returned for the specified ID. Maximum items: 1 Minimum items: 1
territories[]	Model	Each item	Expand Get territory by ID — response body — territories territories item Individual territory object.

Referenced models: Get territory by ID — response body — territories territories item

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or

Field	Type	Presence	Description and constraints
$	object	Root	Represents the grouped filter criterion returned in the response, containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group.
group	array	Required within parent	Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2
group[]	JSON	Each item
group[] (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value
group[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or
group_operator	string	Required within parent	Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. Known values: AND, OR, and, or

Referenced models: Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or, Get territory by ID — response body — territories territories item deal rule criteria value

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: between, not between, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the between and not_between comparators. The value is an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the between filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the range comparison operator returned for the criterion, indicating whether the field value falls within or outside the specified bounds. Possible values: between - Matches records where the field value falls within the specified range. not_between - Matches records where the field value falls outside the specified range. Known values: between, not_between
field	JSON	Required within parent	Represents the target field definition to which the range filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the range filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains the two boundary values — [lower_bound, upper_bound] — against which the field was evaluated for the between or not_between comparator. Maximum items: 2 Minimum items: 2
value[]	JSON	Each item
value[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: in, not in, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the in and not_in comparators. The value is an array of primitive values. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the set filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the set membership comparison operator returned for the criterion. Possible values: in - Matches records where the field value is in the specified set of values. not_in - Matches records where the field value is not in the specified set of values. Known values: in, not_in
field	JSON	Required within parent	Represents the target field definition to which the set filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the set filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains an array of primitive filter values returned for the set comparison. Maximum items: 500 Minimum items: 1
value[]	JSON	Each item
value[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the multi-select lookup filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the multi-select lookup comparison operator returned for the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Possible values: include_all - Matches records that include all specified lookup values. include_any - Matches records that include at least one of the specified lookup values. exclude_all - Matches records that exclude all specified lookup values. exclude_any - Matches records that exclude at least one of the specified lookup values. Known values: include_all, include_any, exclude_all, exclude_any
field	JSON	Required within parent	Represents the target field definition to which the multi-select lookup filter criterion was applied. The field has a data_type of multiuserlookup or multiselectlookup.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains an array of lookup object references returned for the multi-select comparison. Maximum items: 500 Minimum items: 1
value[]	Model	Each item	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a lookup object filter criterion value for response bodies, applicable when the field's data_type is lookup, ownerlookup, or userlookup. Both the ID and name properties are included.
$ (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item id, name
$ (allOf 2)	object	All variants apply	Represents the constraint that both the ID and name properties are required for the lookup object filter criterion value in response bodies. Additional keys: allowed
$ (allOf 2).id	JSON	Required within parent
$ (allOf 2).name	JSON	Required within parent

Referenced models: Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item id, name

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the less_than, less_equal, greater_than, and greater_equal comparators. The value is a scalar; arrays and objects are not valid. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the ordering filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the ordering comparison operator returned for the criterion. Possible values: less_than - Matches records where the field value is less than the specified filter value. less_equal - Matches records where the field value is less than or equal to the specified filter value. greater_than - Matches records where the field value is greater than the specified filter value. greater_equal - Matches records where the field value is greater than or equal to the specified filter value. Known values: less_than, less_equal, greater_than, greater_equal
field	JSON	Required within parent	Represents the target field definition to which the ordering filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the scalar filter value returned for the ordering comparator.
value (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 3)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	number	Alternative	Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double.
$ (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value is a string scalar or array; SimpleFilterCriterionValueString applies to text-based field types. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the text filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the text comparison operator returned for the criterion. Possible values: like - Matches records where the field value contains the specified pattern. not_like - Matches records where the field value does not contain the specified pattern. starts_with - Matches records where the field value begins with the specified string. ends_with - Matches records where the field value ends with the specified string. contains - Matches records where the field value contains the specified string. not_contains - Matches records where the field value does not contain the specified string. Known values: like, not_like, starts_with, ends_with, contains, not_contains
field	JSON	Required within parent	Represents the target field definition to which the text filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the text filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the string filter value returned for the text comparator. Contains a scalar string or an array of string values.
value (anyOf 1)	array	Alternative	Contains an array of primitive string values returned for the text filter comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime; SimpleFilterCriterionValueNumber for integer, currency, or double; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup, ownerlookup, or userlookup; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the equal comparison operator returned for the criterion. Possible values: equal - Matches records where the field value equals the specified filter value. Known values: equal
field	JSON	Required within parent	Represents the target field definition to which the equal filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, value, pre_defined, field Default: value
value	JSON	Required within parent	Represents the filter value returned for the equal comparator. Contains a scalar or an array of values, depending on the field's data_type.
value (anyOf 1)	array	Alternative	Contains an array of filter values returned for the equal comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 1)[] (anyOf 3)	JSON	Alternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 1)[] (anyOf 3) (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 3)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 4)	boolean	Alternative	Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 6)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 7)	string	Alternative	Represents a predefined placeholder value applicable to any field data_type with the equal comparator. Possible values: ${EMPTY} - Matches records where the field has no value. ${NOTEMPTY} - Matches records where the field has any non-empty value. Known values: ${EMPTY}, ${NOTEMPTY}
value (anyOf 8)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string
value (anyOf 9)	string	Alternative	Represents a predefined N-period range placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Follows the pattern ${NEXT_N_<PERIOD>:<n>} or ${LAST_N_<PERIOD>:<n>}, where PERIOD is DAYS, WEEKS, MONTHS, or YEARS and n is a positive integer. The current period is always excluded from the range. Maximum length: 255 Pattern: ^\$\{(LAST_N_|NEXT_N_)(DAYS|WEEKS|MONTHS|YEARS):([0-9]+)\}$
value (anyOf 10)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string

Field	Type	Presence	Description and constraints
$	string	Root	Represents a predefined placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Known values: ${TODAY}, ${TOMORROW}, ${TOMORROWPLUS}, ${YESTERDAY}, ${YESTERDAYMINUS}, ${LASTMONTH}, ${THISMONTH}, ${NEXTMONTH}, ${LASTWEEK}, ${THISWEEK}, ${NEXTWEEK}, ${THISYEAR}, ${THISFY}, ${THISFQ}, ${LASTYEAR}, ${PREVFY}, ${PREVFQ}, ${NEXTYEAR}, ${NEXTFY}, ${NEXTFQ}, ${EMPTY}, ${NOTEMPTY}

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a predefined placeholder object filter criterion value for lookup fields, applicable with equal or not_equal comparators when the field's data_type is ownerlookup or userlookup. Two forms are supported: (1) the currently logged-in user, represented by passing only the name property with the predefined value ${CURRENTUSER} and no ID property; and (2) the logged-in user's role, represented by passing the ID property with the predefined value ${CURRENTUSERROLE} and an optional display label in the name property. For specific real users or roles that are not predefined, use SimpleFilterCriterionValueObjectRequest, which requires the ID property.
$ (anyOf 1)	object	Alternative	Represents the predefined object form for the currently logged-in user, in which only the name property carries the predefined value ${CURRENTUSER} and no ID property is included. Additional keys: not allowed
$ (anyOf 1).name	string	Required within parent	Represents the predefined placeholder for the currently logged-in user. Possible values: ${CURRENTUSER} - Represents the currently logged-in user. Known values: ${CURRENTUSER}
$ (anyOf 2)	object	Alternative	Represents the predefined object form for the currently logged-in user's role, in which the ID property carries the predefined value ${CURRENTUSERROLE} and the name property is an optional display label. Additional keys: allowed
$ (anyOf 2).id	string	Required within parent	Represents the predefined placeholder for the logged-in user's role record ID. Possible values: ${CURRENTUSERROLE} - Represents the role of the currently logged-in user. Known values: ${CURRENTUSERROLE}
$ (anyOf 2).name	string	Optional	Represents an optional display label for the predefined role, such as Logged in User Role. Maximum length: 255

Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response for a filter criterion using the not_equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text-based types; SimpleFilterCriterionValueNumber for numeric types; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup types; and SimpleFilterCriterionValueObjectPredefined for predefined user or role placeholders. Additional keys: not allowed
$disrupted	boolean	Optional	Indicates whether the not-equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparator	string	Required within parent	Represents the not-equal comparison operator returned for the criterion. Possible values: not_equal - Matches records where the field value does not equal the specified filter value. Known values: not_equal
field	JSON	Required within parent	Represents the target field definition to which the not-equal filter criterion was applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion response. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, value, pre_defined, field Default: value
value	JSON	Required within parent	Represents the filter value returned for the not_equal comparator. Contains a scalar or an array of values, depending on the field's data_type.
value (anyOf 1)	array	Alternative	Contains an array of filter values returned for the not_equal comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 1)[] (anyOf 3)	JSON	Alternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 1)[] (anyOf 3) (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 3)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 4)	boolean	Alternative	Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 6)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 7)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Get territory by ID — response body — territories territories item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single territory record returned by the API. Additional keys: not allowed
account_rule_criteria	JSON	Optional	Represents the criteria used to auto-assign accounts to the territory.
account_rule_criteria (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value
account_rule_criteria (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or
account_rule_criteria (anyOf 3)	null	Alternative	Represents the absence of an account rule criteria for the territory. Must equal: null
api_name	string	Required within parent	Represents the unique API name of the territory used in API requests. Maximum length: 100
created_by	object	Required within parent	Represents the user who created the territory. Additional keys: not allowed
created_by.id	string	Required within parent	Represents the unique identifier of the user who created the territory. Format: int64
created_by.name	string	Required within parent	Represents the display name of the user who created the territory. Maximum length: 100
created_time	string	Required within parent	Represents the date and time the territory record took effect, in ISO 8601 format. Format: date-time
deal_rule_criteria	JSON	Optional	Represents the criteria used to auto-assign deals to the territory.
deal_rule_criteria (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value
deal_rule_criteria (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or
deal_rule_criteria (anyOf 3)	null	Alternative	Represents the absence of a deal rule criteria for the territory. Must equal: null
description	JSON	Required within parent
description (anyOf 1)	null	Alternative	Represents the absence of a description for the territory. Must equal: null
description (anyOf 2)	string	Alternative	Represents the description of the territory. Maximum length: 250
id	string	Required within parent	Represents the unique identifier of the territory. Format: int64
lead_rule_criteria	JSON	Optional	Represents the criteria used to auto-assign leads to the territory.
lead_rule_criteria (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value
lead_rule_criteria (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or
lead_rule_criteria (anyOf 3)	null	Alternative	Represents the absence of a lead rule criteria for the territory. Must equal: null
manager	JSON	Required within parent
manager (anyOf 1)	object	Alternative	Represents a territory manager identified by user ID. Additional keys: not allowed
manager (anyOf 1).id	string	Required within parent	Represents the unique identifier of the territory manager. Format: int64
manager (anyOf 1).name	string	Required within parent	Represents the display name of the territory manager. Maximum length: 100
manager (anyOf 1).status	string	Optional	Represents the current status of the territory manager. Possible values: **deleted**, **rejected**, **active**, **closed**, **disabled**. Known values: deleted, rejected, active, closed, disabled
manager (anyOf 1).zuid	string	Optional	Represents the Zoho User ID (ZUID) of the territory manager. Format: int32
manager (anyOf 2)	null	Alternative	Represents the absence of a territory manager. Must equal: null
modified_by	object	Required within parent	Represents the user who last modified the territory. Additional keys: not allowed
modified_by.id	string	Required within parent	Represents the unique identifier of the user who last modified the territory. Format: int64
modified_by.name	string	Required within parent	Represents the display name of the user who last modified the territory. Maximum length: 100
modified_time	string	Required within parent	Represents the date and time when the territory was last modified, in ISO 8601 format. Format: date-time
name	string	Required within parent	Represents the display name of the territory. Maximum length: 50
permission_type	string	Required within parent	Represents the access permission for users in this territory. Possible values: **read_write_delete**, **read_only**. Known values: read_write_delete, read_only
reporting_to	JSON	Required within parent
reporting_to (anyOf 1)	object	Alternative	Represents the parent territory to which this territory reports in the hierarchy. Additional keys: not allowed
reporting_to (anyOf 1).id	string	Required within parent	Represents the unique identifier of the parent territory. Format: int64
reporting_to (anyOf 1).name	string	Required within parent	Represents the display name of the parent territory. Maximum length: 100
reporting_to (anyOf 2)	null	Alternative	Represents the absence of a parent territory for this territory. Must equal: null

Referenced models: Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or, Get territory by ID — response body — territories territories item deal rule criteria value

Get territory by ID — response body — territories territories item deal rule criteria value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the response for a simple field-based filter criterion, dispatching to the appropriate comparator-specific response schema.
$ (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value value
$ (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
$ (anyOf 3)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field
$ (anyOf 4)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: between, not between, type: merge field, pre defined, value, field
$ (anyOf 5)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: in, not in, type: merge field, pre defined, value, field
$ (anyOf 6)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field

Referenced models: Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: between, not between, type: merge field, pre defined, value, field, Get territory by ID — response body — territories territories item deal rule criteria value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: in, not in, type: merge field, pre defined, value, field, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field

Get territory by ID — response body — territories territories item deal rule criteria value value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the response for an equality filter criterion that dispatches to either the EqualFilterCriterionResponse or NotEqualFilterCriterionResponse schema based on the comparator value.
$ (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field
$ (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field

Referenced models: Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field

Get territory-associated user counts — response body — associated users count, info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the count of users associated with each territory. Additional keys: not allowed
associated_users_count	array	Required within parent	Represents the list of objects containing the count of users associated with each territory. Maximum items: 200 Minimum items: 1
associated_users_count[]	object	Each item	Represents the error details for a single territory with its associated user count. Additional keys: not allowed
associated_users_count[].count	JSON	Required within parent
associated_users_count[].count (anyOf 1)	integer	Alternative	Represents the total number of users associated with the territory. Format: int32 Minimum: 0
associated_users_count[].count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
associated_users_count[].territory	object	Required within parent	Represents the territory object associated with the user count. Additional keys: not allowed
associated_users_count[].territory.id	string	Required within parent	Represents the unique identifier of the territory. Format: int64
associated_users_count[].territory.name	string	Required within parent	Represents the display name of the territory. Maximum length: 50
info	object	Required within parent	Represents the pagination metadata for the response. Additional keys: not allowed
info.count	JSON	Required within parent
info.count (anyOf 1)	integer	Alternative	Represents the total number of records available in the current response. Format: int32 Minimum: 0
info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.more_records	boolean	Required within parent	Represents whether additional records are available beyond the current page.
info.page	JSON	Required within parent
info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32 Minimum: 1
info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.per_page	JSON	Required within parent
info.per_page (anyOf 1)	integer	Alternative	Represents the number of records returned per page. Format: int32 Maximum: 2000 Minimum: 1
info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Remove territories from a record — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when territories are successfully removed from a record. Additional keys: not allowed
data	array	Required within parent	Represents the list of territory removal results for the records. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Remove territories from a record — response body — data data item

Referenced models: Remove territories from a record — response body — data data item

Remove territories from a record — response body — data data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details for a single territory removal operation. Additional keys: not allowed
code	string	Required within parent	Represents the result code for the territory removal. Possible values: **SUCCESS**. Known values: SUCCESS
details	object	Required within parent	Represents additional details about the territory removal, including the record identifier. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the record from which territories were removed. Format: int64
message	string	Required within parent	Represents the success message returned for the territory removal. Possible values: **the territories data removed successfully**. Known values: the territories data removed successfully
status	string	Required within parent	Represents the status of the territory removal operation. Possible values: **success**. Known values: success

Remove territories from a record — response body — value data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a single-record territory removal job has been scheduled. Additional keys: not allowed
data	array	Required within parent	Represents the list of scheduled territory removal results. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Remove territories from a record — response body — value data data item

Referenced models: Remove territories from a record — response body — value data data item

Remove territories from a record — response body — value data data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details for a single scheduled territory removal operation. Additional keys: not allowed
code	string	Required within parent	Represents the result code for the scheduled territory removal. Possible values: **SCHEDULED**. Known values: SCHEDULED
details	Model	Required within parent	Expand Remove territories from a record — response body — value data data item details
message	string	Required within parent	Represents the success message returned when the territory removal is scheduled. Possible values: **Territory removal process scheduled successfully**. Known values: Territory removal process scheduled successfully
status	string	Required within parent	Represents the status of the scheduled territory removal operation. Possible values: **success**. Known values: success

Referenced models: Remove territories from a record — response body — value data data item details

Remove territories from a record — response body — value data data item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents additional details about the scheduled territory removal, including the record and job identifiers. Additional keys: not allowed
id	string	Required within parent	Represents the unique identifier of the record for which territory removal was scheduled. Format: int64
job_id	string	Required within parent	Represents the unique identifier of the scheduled territory removal job. Format: int64

Remove territories from multiple records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when territories are successfully removed from records. Additional keys: not allowed
data	array	Required within parent	Represents the list of territory removal results. Maximum items: 10 Minimum items: 1
data[]	Model	Each item	Expand Remove territories from a record — response body — data data item

Referenced models: Remove territories from a record — response body — data data item

Remove territories from multiple records — response body — value data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a territory removal job has been scheduled. Additional keys: not allowed
data	array	Required within parent	Represents the list of scheduled territory removal results. Maximum items: 10 Minimum items: 1
data[]	Model	Each item	Expand Remove territories from a record — response body — value data data item

Referenced models: Remove territories from a record — response body — value data data item

Run territory assignment rules — request body — body / run_rules / based_on: criteria module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the CRM module associated with the territory rule, identified by either its unique ID or API name. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the module associated with the territory rule. Maximum length: 50
id	string	Optional	Represents the unique identifier of the module associated with the territory rule. Format: int64
$ (anyOf 1)	JSON	Alternative	Represents the module identified by its unique ID.
$ (anyOf 2)	JSON	Alternative	Represents the module identified by its API name.

Run territory assignment rules — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when territory rules execution has been scheduled. Additional keys: not allowed
run_rules	object	Required within parent	Represents the result of the scheduled territory rules execution. Additional keys: not allowed
run_rules.code	string	Required within parent	Represents the result code for the scheduled territory rules execution. Possible values: **SCHEDULED**. Known values: SCHEDULED
run_rules.details	object	Required within parent	Represents additional details about the scheduled execution, including the job identifier. Additional keys: not allowed
run_rules.details.job_id	string	Required within parent	Represents the unique identifier of the scheduled territory rules execution job. Format: int64
run_rules.message	string	Required within parent	Represents the success message returned when territory rules execution is scheduled. Possible values: **Territory rules scheduled successfully.Once done, completion email is sent.**, **Territory rules Scheduled successfully.Once done Completion email will sent**. Known values: Territory rules scheduled successfully.Once done, completion email will be sent., Territory rules Scheduled successfully.Once done Completion email will sent Maximum length: 100
run_rules.status	string	Required within parent	Represents the status of the scheduled territory rules execution. Possible values: **success**. Known values: success

Transfer and delete territories — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a territory is successfully transferred and deleted. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects transferred and deleted by the request. Maximum items: 100 Minimum items: 1
territories[]	object	Each item	Represents the error details for a single territory transfer and delete operation. Additional keys: not allowed
territories[].code	string	Required within parent	Represents the result code for the territory transfer and deletion. Possible values: **SUCCESS**. Known values: SUCCESS
territories[].details	object	Required within parent	Represents additional details about the transferred and deleted territory, including its unique identifier. Additional keys: not allowed
territories[].details.id	string	Required within parent	Represents the unique identifier of the transferred and deleted territory. Format: int64
territories[].message	string	Required within parent	Represents the success message returned for the territory transfer and deletion. Possible values: **Territory Transferred And Deleted Successfully**, **Given Territory Removed Successfully and its child Territories moved to the another territory**. Known values: Territory Transferred And Deleted Successfully, Given Territory Removed Successfully and its child Territories moved to the another territory Maximum length: 100
territories[].status	string	Required within parent	Represents the status of the territory transfer and delete operation. Possible values: **success**. Known values: success

Update territories — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when one or more territories are successfully updated. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects updated by the request. Maximum items: 100 Minimum items: 1
territories[]	object	Each item	Represents the error details for a single territory update operation. Additional keys: not allowed
territories[].code	string	Required within parent	Represents the result code for the territory update. Possible values: **SUCCESS**. Known values: SUCCESS
territories[].details	object	Required within parent	Represents additional details about the updated territory, including its unique identifier. Additional keys: not allowed
territories[].details.id	string	Required within parent	Represents the unique identifier of the updated territory. Format: int64
territories[].message	string	Required within parent	Represents the success message returned for the territory update. Possible values: **Territory Updated Successfully**. Known values: Territory Updated Successfully Maximum length: 100
territories[].status	string	Required within parent	Represents the status of the territory update operation. Possible values: **success**. Known values: success