Skip to content

Update Group

The groups update command updates an existing group from inline parameters or a JSON file. Uses GROUP_ID if given, otherwise resolves by --name.

Modes

Mode When to Use
Inline Quick field updates โ€” pass only the fields to change as CLI flags.
File (--file) Bulk or complex updates โ€” provide a JSON file with fields to change.

Both modes are mutually exclusive. If --file is provided, all inline parameters are ignored.

Parameters

Identification

Parameter Description
GROUP_ID Group ID (optional positional). Omit to use --name resolution.
--name, -n Group name โ€” used to look up the group ID when GROUP_ID is omitted. Can also update the name itself.

File Mode

Parameter Description
--file, -f JSON file with group updates.

Inline Parameters (all optional โ€” only provided fields are updated)

Parameter Description
--description, -d Group description.
--active / --inactive Active status.
--timezone, -z Timezone in IANA format.
--trigger-times Comma-separated times in HH:MM format. Automatically deduplicated and sorted.
--day-of-week 7-character binary string for MTWTFSS (e.g. 1111100 = Monโ€“Fri).
--ordinal-day Ordinal day description.
--run-frequency Run frequency in HH:MM-HH:MM-freq format.
--calendar Calendar name (must exist in the backend).
--dependency Dependency string (e.g. S:groupname).
--profile Profile name.

Mutual Exclusivity

  • Only one of --trigger-times or --run-frequency may be provided (not both).
  • Only one of --day-of-week or --ordinal-day may be provided (not both).

๐Ÿ–ฅ๏ธ Basic Usage

easytask groups update -h
 Usage: easytask groups update [OPTIONS] [GROUP_ID]

 Update a group from inline parameters or a JSON file. Uses GROUP_ID if
 given, otherwise looks up by name.

โ•ญโ”€ Arguments โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚   group_id      INTEGER  Group ID (optional if using --name or --file)          โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ --file            -f      PATH     JSON file with group updates                  โ”‚
โ”‚ --name            -n      TEXT     Group name (also resolves ID if GROUP_ID     โ”‚
โ”‚                                            is omitted)                           โ”‚
โ”‚ --description     -d      TEXT     Group description                             โ”‚
โ”‚ --active / --inactive               Active status                              โ”‚
โ”‚ --timezone        -z      TEXT     Timezone                                    โ”‚
โ”‚ --trigger-times            TEXT     Comma-separated HH:MM                       โ”‚
โ”‚ --day-of-week              TEXT     7-char binary MTWTFSS                       โ”‚
โ”‚ --ordinal-day              TEXT     Ordinal day                                โ”‚
โ”‚ --run-frequency            TEXT     HH:MM-HH:MM-freq                           โ”‚
โ”‚ --calendar                 TEXT     Calendar name                              โ”‚
โ”‚ --dependency               TEXT     Dependency string                           โ”‚
โ”‚ --profile                  TEXT     Profile name                               โ”‚
โ”‚ --help             -h               Show this message and exit.                 โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Inline Mode Examples

Update group description by ID

easytask groups update 10 --description "Updated: Daily batch processing jobs v2"
Group 10 updated.

Update group trigger times (automatically sorted)

easytask groups update 11 --trigger-times "12:00,03:00,07:00,18:00"
Group 11 updated.

Update group by name resolution

When you don't know the group ID, use --name to look it up:

easytask groups update --name "daily_jobs" --active
Resolved name 'daily_jobs' โ†’ ID 10
Group 10 updated.

Update group timezone

easytask groups update 12 --timezone "Asia/Tokyo"
Group 12 updated.

Deactivate a group

easytask groups update 14 --inactive
Group 14 updated.

File Mode Examples

Sample Input

group_update.json
{
  "trigger_times": "07:00",
  "description": "Updated daily batch processing jobs"
}

Example

easytask groups update 10 -f group_update.json
Group 10 updated.

โญ๏ธ Next Steps