Zoho: Territories schemas
25 Zoho schemas with complete fields and constraints.
← 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
| 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 Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
account_rule_criteria (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / 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 Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
deal_rule_criteria (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / 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 Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
lead_rule_criteria (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / 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: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
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 |