Zoho: Users territories schemas
3 Zoho schemas with complete fields and constraints.
← Users territories operations · All schemas
Add territories to a user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response containing the per-territory operation results. Additional keys: not allowed |
territories | array | Required within parent | Represents the list of per-territory operation results. Maximum items: 200 Minimum items: 0 Unique items: true |
territories[] | object | Each item | Represents the result of a single territory operation. Additional keys: not allowed |
territories[].code | string | Required within parent | Represents the result code for the territory operation. Possible values: SUCCESS - The territory operation completed successfully. Known values: SUCCESS |
territories[].details | object | Required within parent | Represents the additional details for the operation result. Additional keys: not allowed |
territories[].details.id | string | Required within parent | Represents the unique ID of the territory on which the operation was performed. Format: int64 |
territories[].message | string | Required within parent | Represents the message describing the result of the territory operation. Maximum length: 1000 |
territories[].status | string | Required within parent | Represents the status of the territory operation. Possible values: success - The operation completed successfully. Known values: success |
Get territories of a user — response body — info, territories
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response containing territories assigned to a user and pagination details. Additional keys: not allowed |
info | object | Required within parent | Represents the pagination details for the response. Additional keys: not allowed |
info.count | JSON | Required within parent | |
info.count (anyOf 1) | integer | Alternative | Represents the number of territory records returned in the current page. Format: int32 |
info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.more_records | boolean | Required within parent | Indicates whether more territory records are available beyond the current page. Possible values: true - More records are available. false - No more records are available. |
info.page | JSON | Required within parent | |
info.page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Format: int32 |
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 maximum number of records returned per page. Format: int32 |
info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
territories | array | Required within parent | The JSON array representing the list of territories assigned to the user. Maximum items: 200 Minimum items: 0 Unique items: true |
territories[] | Model | Each item | Expand Get territories of a user — response body — info, territories territories item |
Referenced models: Get territories of a user — response body — info, territories territories item
Get territories of a user — response body — info, territories territories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a single territory assigned to the user. Additional keys: not allowed |
Manager | object | Required within parent | Represents the manager of the territory. Valid user IDs and names can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API. Additional keys: not allowed |
Manager.Name | string | Optional | Represents the full name of the territory manager. Maximum length: 255 |
Manager.id | string | Optional | Represents the unique ID of the territory manager. Format: int64 |
Name | string | Required within parent | Represents the name of the territory. Maximum length: 255 |
Reporting_To | object | Required within parent | Represents the parent territory that this territory reports to in the hierarchy. Additional keys: not allowed |
Reporting_To.Name | string | Required within parent | Represents the name of the parent territory or reporting entity. Maximum length: 255 |
Reporting_To.id | string | Required within parent | Represents the unique ID of the parent territory or reporting entity. Format: int64 |
id | string | Required within parent | Represents the unique ID of the territory. Format: int64 |