Zoho: Shift hours schemas
12 Zoho schemas with complete fields and constraints.
← Shift hours operations · All schemas
Delete a shift hour — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body that contains the shift hour configurations and the aggregate count of shifts with assigned users. Additional keys: not allowed |
shift_hours | array | Required within parent | Lists the shift hour configurations in the request or response. Maximum items: 50 |
shift_hours[] | object | Each item | Each object represents one shift hour with its timing, break hours, holidays, and assigned users. Additional keys: not allowed |
shift_hours[].code | string | Required within parent | Represents the response code of the operation. Known values: SUCCESS |
shift_hours[].details | object | Required within parent | Represents additional details about the outcome of the operation. Additional keys: not allowed |
shift_hours[].details.id | string | Required within parent | Represents the unique identifier of the shift hour affected by the operation. Maximum length: 100 |
shift_hours[].message | string | Required within parent | Represents the message that describes the outcome of the operation. Maximum length: 100 |
shift_hours[].status | string | Required within parent | Represents the status of the operation. Known values: success |
Get a shift hour — response body — shift count, shift hours shift hours item break hours null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the days the break applies to and the break timing for those days. Additional keys: not allowed |
break_days | array | Required within parent | Lists the days of the week on which the break hour applies. Maximum items: 7 |
break_days[] | string | Each item | Each string represents a day of the week on which the break hour applies. Maximum length: 100 |
custom_timing | JSON | Required within parent | |
custom_timing (anyOf 1) | array | Alternative | Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 50 |
custom_timing (anyOf 1)[] | Model | Each item | Expand Get a shift hour — response body — shift count, shift hours shift hours item break hours null item custom timing Lists per-day break timing overrides item |
custom_timing (anyOf 2) | null | Alternative | Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 50 |
custom_timing (anyOf 2)[] | Model | Each item | Expand Get a shift hour — response body — shift count, shift hours shift hours item break hours null item custom timing Lists per-day break timing overrides item |
daily_timing | array | Required within parent | Represents the start and end time of the break in `HH:MM` 24-hour format, applied uniformly to every day the break is scheduled. This field is **mandatory** when the parent **same_as_everyday** is **true**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 50 |
daily_timing[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
id | string | Required within parent | Represents the unique identifier of the break hour within the shift hour. Maximum length: 100 |
same_as_everyday | boolean | Required within parent | Indicates whether the break hour follows the same timing on every day the break is scheduled. **Possible values**: - **true** - the break hour uses the same timing every day, and **daily_timing** becomes mandatory. - **false** - the break hour uses different timing for different days, and **custom_timing** becomes mandatory. |
Referenced models: Get a shift hour — response body — shift count, shift hours shift hours item break hours null item custom timing Lists per-day break timing overrides item
Get a shift hour — response body — shift count, shift hours shift hours item break hours null item custom timing Lists per-day break timing overrides item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the day of the week and the start and end time of the break on that day. Additional keys: not allowed |
break_timing | array | Required within parent | Represents the start and end time of the break on the specified day in `HH:MM` 24-hour format. A break must be longer than 15 minutes and shorter than 2 hours. Maximum items: 7 |
break_timing[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
days | string | Required within parent | Represents the day of the week to which this custom break timing applies. **Possible values**: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday Maximum length: 100 |
Get a shift hour — response body — shift count, shift hours shift hours item custom timing null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the day of the week and the start and end time of the shift on that day. Additional keys: not allowed |
days | string | Required within parent | Represents the day of the week to which this custom shift timing applies. **Possible values**: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday Maximum length: 100 |
shift_timing | array | Required within parent | Represents the start and end time of the shift on the specified day in `HH:MM` 24-hour format. Maximum items: 7 |
shift_timing[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
Get a shift hour — response body — shift count, shift hours shift hours item holidays null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the date and the name of the holiday. Additional keys: not allowed |
date | string | Required within parent | Represents the date of the holiday in `YYYY-MM-DD` format. Format: date |
id | string | Required within parent | Represents the unique identifier of the holiday. Maximum length: 100 |
name | string | Required within parent | Represents the name of the holiday. The name must not contain the special characters. Maximum length: 80 |
userFmt | string | Required within parent | Represents the holiday date formatted using the date format configured for the requesting user. Maximum length: 100 |
year | object | Required within parent | Represents the year of the holiday. Additional keys: not allowed |
Get a shift hour — response body — shift count, shift hours shift hours item users null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object represents one user assigned to the shift hour, including the user details and the effective date of the assignment. Additional keys: not allowed |
effective_from | string | Required within parent | Represents the date from which the user assignment to the shift hour becomes effective, in `YYYY-MM-DD` format. The date must be in the future and must not be more than six months ahead of the current date. Format: date |
email | string | Required within parent | Represents the email address of the user assigned to the shift hour. Maximum length: 100 |
id | string | Required within parent | Represents the unique identifier of the user assigned to the shift hour. Maximum length: 100 |
name | string | Required within parent | Represents the full name of the user assigned to the shift hour. Maximum length: 100 |
role | object | Required within parent | Represents the role information of the user assigned to the shift hour. Additional keys: not allowed |
role.id | string | Required within parent | Represents the unique identifier of the role assigned to the user. Maximum length: 100 |
role.name | string | Required within parent | Represents the name of the role assigned to the user. Maximum length: 100 |
zuid | string | Required within parent | Represents the unique identifier of the user assigned to the shift hour. Maximum length: 100 |
Get shift hours — response body — shift count, shift hours shift hours item break hours null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the days the break applies to and the break timing for those days. Additional keys: not allowed |
break_days | array | Required within parent | Lists the days of the week on which the break hour applies. Possible values: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday Maximum items: 7 |
break_days[] | string | Each item | Represents one day of the week on which the break hour applies. Known values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
custom_timing | JSON | Required within parent | |
custom_timing (anyOf 1) | array | Alternative | Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 7 |
custom_timing (anyOf 1)[] | Model | Each item | Expand Get shift hours — response body — shift count, shift hours shift hours item break hours null item custom timing null item |
custom_timing (anyOf 2) | null | Alternative | Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 7 |
custom_timing (anyOf 2)[] | Model | Each item | Expand Get shift hours — response body — shift count, shift hours shift hours item break hours null item custom timing null item |
daily_timing | JSON | Required within parent | |
daily_timing (anyOf 1) | array | Alternative | Represents the start and end time of the break in `HH:MM` 24-hour format, applied uniformly to every day the break is scheduled. This field is **mandatory** when the parent **same_as_everyday** is **true**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 2 Minimum items: 2 |
daily_timing (anyOf 1)[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. `HH:MM` 24-hour format. " Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
daily_timing (anyOf 2) | null | Alternative | Represents the start and end time of the break in `HH:MM` 24-hour format, applied uniformly to every day the break is scheduled. This field is **mandatory** when the parent **same_as_everyday** is **true**. A day can have at most two breaks and the total break time on a day cannot exceed two hours. Maximum items: 2 Minimum items: 2 |
daily_timing (anyOf 2)[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. `HH:MM` 24-hour format. " Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
id | string | Required within parent | Represents the unique identifier of the break hour within the shift hour. Maximum length: 100 Pattern: ^[0-9]+$ |
same_as_everyday | boolean | Required within parent | Indicates whether the break hour follows the same timing on every day the break is scheduled. Possible values: - `true` - the break hour uses the same timing every day, and `daily_timing` becomes mandatory. - `false` - the break hour uses different timing for different days, and `custom_timing` becomes mandatory. |
Referenced models: Get shift hours — response body — shift count, shift hours shift hours item break hours null item custom timing null item
Get shift hours — response body — shift count, shift hours shift hours item break hours null item custom timing null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the day of the week and the start and end time of the break on that day. Additional keys: not allowed |
break_timing | array | Required within parent | Represents the start and end time of the break on the specified day in `HH:MM` 24-hour format. A break must be longer than 15 minutes and shorter than 2 hours. Maximum items: 2 Minimum items: 2 |
break_timing[] | string | Each item | "Represents the start time or end time of the window in `HH:MM` 24-hour format. " Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
days | string | Required within parent | Represents the day of the week to which this custom break timing applies. **Possible values**: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday Known values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
Get shift hours — response body — shift count, shift hours shift hours item custom timing Lists per-day shift timing overrides item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the day of the week and the start and end time of the shift on that day. This field is mandatory when **same_as_everyday** is **false**. Additional keys: not allowed |
days | string | Required within parent | Represents the day of the week to which this custom shift timing applies. **Possible values**: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday Known values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
shift_timing | array | Required within parent | Represents the start and end time of the shift on the specified day in `HH:MM` 24-hour format. Maximum items: 2 Minimum items: 2 |
shift_timing[] | string | Each item | Represents the start time or end time of the window in `HH:MM` 24-hour format. The first array entry is the start time and the second is the end time. Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
Get shift hours — response body — shift count, shift hours shift hours item holidays null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each entry specifies the date and the name of the holiday. Additional keys: not allowed |
date | string | Required within parent | Represents the date of the holiday in `YYYY-MM-DD` format. Format: date |
id | string | Required within parent | Represents the unique identifier of the holiday. Maximum length: 100 Pattern: ^[0-9]+$ |
name | string | Required within parent | Represents the name of the holiday. The name must not contain the special characters. Maximum length: 80 |
userFmt | string | Required within parent | Represents the holiday date formatted using the date format configured for the requesting user. Maximum length: 100 |
year | string | Required within parent | Represents the year of the holiday. Maximum length: 100 |
Get shift hours — response body — shift count, shift hours shift hours item users Lists the users assigned to the shift hour item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the user and the date from which the assignment becomes effective. Additional keys: not allowed |
effective_from | string | Required within parent | Represents the date from which the user assignment to the shift hour becomes effective, in `YYYY-MM-DD` format. The date must be in the future and must not be more than six months ahead of the current date. Format: date |
email | string | Required within parent | Represents the email address of the user assigned to the shift hour. Format: email |
id | string | Required within parent | Represents the unique identifier of the user assigned to the shift hour. Maximum length: 100 Pattern: ^[0-9]+$ |
name | string | Required within parent | Represents the full name of the user assigned to the shift hour. Maximum length: 100 |
role | object | Required within parent | Represents the role information of the user assigned to the shift hour. Additional keys: not allowed |
role.id | string | Required within parent | Represents the unique identifier of the role assigned to the user. Maximum length: 100 Pattern: ^[0-9]+$ |
role.name | string | Required within parent | Represents the name of the role assigned to the user. Maximum length: 100 |
zuid | string | Required within parent | Represents the unique identifier of the user assigned to the shift hour. Maximum length: 100 |
Update shift hours — request body — body shift hours item break hours item custom timing item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each object specifies the day of the week and the start and end time of the break on that day. Additional keys: not allowed |
break_timing | array | Optional | Represents the start and end time of the break on the specified day in `HH:MM` 24-hour format. A break must be longer than 15 minutes and shorter than 2 hours. Maximum items: 7 |
break_timing[] | string | Each item | Each string represents the start time or end time of the window in `HH:MM` 24-hour format. Maximum length: 5 Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ |
days | string | Optional | Represents the day of the week to which this custom break timing applies. **Possible values**: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday One of: Monday, Thursday, Friday, Sunday, Wednesday, Tuesday, Saturday |