Zoho: Territory users schemas
7 Zoho schemas with complete fields and constraints.
← Territory users operations · All schemas
Specific Territory User — request body — path
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
territory | string | Required within parent | Territory Id Param in URL. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID. Maximum length: 100 |
user | string | Required within parent | Represents the unique ID of the user as a string, with a maximum length of 100 characters. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve the user ID. Maximum length: 100 |
Specific Territory User — response body — info, users info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata for the response. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of records returned. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether there are more records available beyond the current page. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number. Format: int32 |
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 per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Specific Territory User — response body — info, users users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a user record in Zoho CRM, including personal details, role, profile, and related information. Additional keys: not allowed |
$current_shift | JSON | Optional | |
$current_shift (anyOf 1) | object | Alternative | Represents the user's current shift assignment. |
$current_shift (anyOf 2) | null | Alternative | Represents the user's current shift assignment. |
$next_shift | JSON | Optional | |
$next_shift (anyOf 1) | object | Alternative | Represents the user's next upcoming shift assignment. |
$next_shift (anyOf 2) | null | Alternative | Represents the user's next upcoming shift assignment. |
$shift_effective_from | JSON | Optional | |
$shift_effective_from (anyOf 1) | object | Alternative | Represents the date from which the user's shift becomes effective. |
$shift_effective_from (anyOf 2) | null | Alternative | Represents the date from which the user's shift becomes effective. |
Isonline | boolean | Optional | Indicates whether the user is currently online. |
Modified_By | object | Required within parent | Represents the user who last modified this user record. Additional keys: not allowed |
Modified_By.id | string | Required within parent | Represents the unique ID of the modifier. Maximum length: 100 |
Modified_By.name | string | Required within parent | Represents the full name of the modifier. Maximum length: 200 |
Modified_Time | string | Required within parent | Represents the date and time when the user account was last modified. Format: date-time |
alias | JSON | Optional | |
alias (anyOf 1) | string | Alternative | Represents the user's alias. Maximum length: 50 |
alias (anyOf 2) | null | Alternative | Represents the user's alias. Maximum length: 50 |
category | string | Required within parent | Represents the user's category or type. Known values: regular_user, sandbox_user, light_user |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | Represents the user's city. Maximum length: 100 |
city (anyOf 2) | null | Alternative | Represents the user's city. Maximum length: 100 |
confirm | boolean | Optional | Indicates whether the user has confirmed their account. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Represents the user's country. Maximum length: 100 |
country (anyOf 2) | null | Alternative | Represents the user's country. Maximum length: 100 |
country_locale | string | Optional | Represents the user's country locale. Maximum length: 50 |
created_by | object | Required within parent | Represents the user who created this user record. Additional keys: not allowed |
created_by.id | string | Required within parent | Represents the unique ID of the creator. Maximum length: 100 |
created_by.name | string | Required within parent | Represents the full name of the creator. Maximum length: 200 |
created_time | string | Required within parent | Represents the date and time when the user account was created. Format: date-time |
customize_info | object | Optional | Represents the user's customization preferences. Additional keys: not allowed |
customize_info.bc_view | JSON | Optional | |
customize_info.bc_view (anyOf 1) | object | Alternative | Represents the business card view preference. |
customize_info.bc_view (anyOf 2) | null | Alternative | Represents the business card view preference. |
customize_info.notes_desc | JSON | Optional | |
customize_info.notes_desc (anyOf 1) | object | Alternative | Indicates whether the notes description is visible. |
customize_info.notes_desc (anyOf 2) | null | Alternative | Indicates whether the notes description is visible. |
customize_info.show_detail_view | boolean | Optional | Indicates whether the detail view is visible. |
customize_info.show_home | boolean | Optional | Indicates whether the home page is visible. |
customize_info.show_left_panel | JSON | Optional | |
customize_info.show_left_panel (anyOf 1) | boolean | Alternative | Indicates whether the left panel is visible. |
customize_info.show_left_panel (anyOf 2) | null | Alternative | Indicates whether the left panel is visible. |
customize_info.show_right_panel | JSON | Optional | |
customize_info.show_right_panel (anyOf 1) | boolean | Alternative | Indicates whether the right panel is visible. |
customize_info.show_right_panel (anyOf 2) | null | Alternative | Indicates whether the right panel is visible. |
customize_info.unpin_recent_item | JSON | Optional | |
customize_info.unpin_recent_item (anyOf 1) | object | Alternative | Indicates whether recent items are unpinned. |
customize_info.unpin_recent_item (anyOf 2) | null | Alternative | Indicates whether recent items are unpinned. |
date_format | string | Optional | Represents the user's preferred date format. Maximum length: 50 |
decimal_separator | string | Optional | Represents the user's preferred decimal separator. Known values: Comma, Period |
default_tab_group | string | Optional | Represents the user's default tab group. Maximum length: 100 |
dob | JSON | Optional | |
dob (anyOf 1) | string | Alternative | Represents the user's date of birth. Format: date |
dob (anyOf 2) | null | Alternative | Represents the user's date of birth. Format: date |
fax | JSON | Optional | |
fax (anyOf 1) | string | Alternative | Represents the user's fax number. Maximum length: 30 |
fax (anyOf 2) | null | Alternative | Represents the user's fax number. Maximum length: 30 |
first_name | string | Required within parent | Represents the user's first name. Maximum length: 50 |
full_name | string | Required within parent | Represents the user's full name. Maximum length: 200 |
id | string | Required within parent | Represents the unique identifier of the user. Maximum length: 100 |
language | string | Required within parent | Represents the user's preferred language. Maximum length: 50 |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Represents the user's last name. Maximum length: 50 |
last_name (anyOf 2) | null | Alternative | Represents the user's last name. Maximum length: 50 |
locale | string | Required within parent | Represents the user's locale. Maximum length: 50 |
microsoft | boolean | Optional | Indicates whether the user has Microsoft integration enabled. |
name_format__s | string | Optional | Represents the user's preferred name format. Known values: First Name,Last Name,Salutation, Salutation,First Name,Last Name, First Name,Salutation,Last Name, Last Name,Salutation,First Name, Salutation,Last Name,First Name, Last Name,First Name,Salutation |
number_separator | string | Optional | Represents the user's preferred number separator. Maximum length: 10 |
offset | JSON | Optional | |
offset (anyOf 1) | integer | Alternative | Represents the time zone offset in milliseconds. Format: int32 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
personal_account | boolean | Optional | Indicates whether this is a personal account. |
profile | object | Required within parent | Represents the user's profile. Additional keys: not allowed |
profile.id | string | Required within parent | Represents the unique ID of the user's profile. Maximum length: 100 |
profile.name | string | Required within parent | Represents the name of the user's profile. Maximum length: 100 |
role | object | Required within parent | Represents the user's role. Additional keys: not allowed |
role.id | string | Required within parent | Represents the unique ID of the user's role. Maximum length: 100 |
role.name | string | Required within parent | Represents the name of the user's role. Maximum length: 100 |
sandboxDeveloper | boolean | Optional | Indicates whether the user is a sandbox developer. |
signature | JSON | Optional | |
signature (anyOf 1) | string | Alternative | Represents the user's email signature. Maximum length: 200 |
signature (anyOf 2) | null | Alternative | Represents the user's email signature. Maximum length: 200 |
sort_order_preference__s | string | Optional | Represents the user's sort order preference. Maximum length: 50 |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Represents the user's state or province. Maximum length: 100 |
state (anyOf 2) | null | Alternative | Represents the user's state or province. Maximum length: 100 |
status | string | Required within parent | Represents the user's account status. Known values: inactive, deleted, rejected, active, closed, disabled |
status_reason__s | JSON | Optional | |
status_reason__s (anyOf 1) | string | Alternative | Represents the reason for the user's current status. Maximum length: 100 |
status_reason__s (anyOf 2) | null | Alternative | Represents the reason for the user's current status. Maximum length: 100 |
street | JSON | Optional | |
street (anyOf 1) | string | Alternative | Represents the user's street address. Maximum length: 250 |
street (anyOf 2) | null | Alternative | Represents the user's street address. Maximum length: 250 |
theme | object | Optional | Represents the user's UI theme preferences. Additional keys: not allowed |
theme.background | string | Required within parent | Represents the overall background color of the theme. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
theme.new_background | JSON | Optional | |
theme.new_background (anyOf 1) | string | Alternative | Represents the new background color of the theme. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
theme.new_background (anyOf 2) | null | Alternative | Represents the new background color of the theme. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
theme.normal_tab | Model | Required within parent | Expand Specific Territory User — response body — info, users users item theme normal tab |
theme.screen | string | Required within parent | Represents the screen layout preference. Known values: stretched, fixed |
theme.selected_tab | Model | Required within parent | Expand Specific Territory User — response body — info, users users item theme selected tab |
theme.type | string | Required within parent | Represents the type of theme applied. Known values: default, custom |
time_format | string | Optional | Represents the user's preferred time format. Known values: HH:mm, hh:mm a |
time_zone | string | Optional | Represents the user's time zone. Maximum length: 50 |
website | JSON | Optional | |
website (anyOf 1) | string | Alternative | Represents the user's website URL. Maximum length: 250 Pattern: [a-z0-9]{5}[.]com |
website (anyOf 2) | null | Alternative | Represents the user's website URL. Maximum length: 250 Pattern: [a-z0-9]{5}[.]com |
zip | JSON | Optional | |
zip (anyOf 1) | string | Alternative | Represents the user's postal or zip code. Maximum length: 30 |
zip (anyOf 2) | null | Alternative | Represents the user's postal or zip code. Maximum length: 30 |
zuid | string | Required within parent | Represents the Zoho user ID. Maximum length: 100 |
Referenced models: Specific Territory User — response body — info, users users item theme normal tab, Specific Territory User — response body — info, users users item theme selected tab
Specific Territory User — response body — info, users users item theme normal tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the normal tab theme settings. Additional keys: not allowed |
background | string | Required within parent | Represents the background color of the normal tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
font_color | string | Required within parent | Represents the font color of the normal tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
Specific Territory User — response body — info, users users item theme selected tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the selected tab theme settings. Additional keys: not allowed |
background | string | Required within parent | Represents the background color of the selected tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
font_color | string | Required within parent | Represents the font color of the selected tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
Territory Users — territory Users deassociate Users From Territories — response body — users
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body containing the list of user disassociation results. Additional keys: not allowed |
users | array | Required within parent | Represents the list of user-territory disassociation results. Maximum items: 100 |
users[] | JSON | Each item | Represents a user entry in the territory user list. |
users[] (anyOf 1) | array | Alternative | Represents an array of error details associated with the user entry. Maximum items: 100 |
users[] (anyOf 1)[] | Model | Each item | Expand Territory Users — territory Users deassociate Users From Territories — response body — users users item array item |
Referenced models: Territory Users — territory Users deassociate Users From Territories — response body — users users item array item
Territory Users — territory Users deassociate Users From Territories — response body — users users item array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an error detail for an invalid user ID in the request. Additional keys: not allowed |
code | string | Required within parent | Represents the status code of the disassociation operation for the user. Known values: SUCCESS |
details | object | Required within parent | Represents additional details about the disassociation operation. Additional keys: not allowed |
details.id | string | Required within parent | Represents the unique ID of the user. Maximum length: 100 |
message | string | Required within parent | Represents the status message of the disassociation operation. Maximum length: 250 |
status | string | Required within parent | Represents the status of the disassociation operation for the user. Known values: success |