Skip to content

canvas appointment-groups update

canvas appointment-groups update

Update an appointment group

Synopsis

Update an existing appointment group.

Examples:

canvas appointment-groups update 543 --title "Updated Title"
canvas appointment-groups update 543 --publish
canvas appointment-groups update <group-id> [flags]

Options

      --address string              Updated location address
      --allow-observer              Allow observer sign-up
      --context strings             Context codes (required per spec)
      --description string          Updated description
  -h, --help                        help for update
      --location string             Updated location name
      --max-slots int               Max slots per participant
      --min-slots int               Min slots per participant
      --participants-per-slot int   Max participants per slot
      --publish                     Publish the appointment group
      --title string                Updated title
      --visibility string           Participant visibility: private or protected

Options inherited from parent commands

      --as-user int       Masquerade as another user (admin feature, requires permission)
      --columns strings   Select specific columns to display (comma-separated)
      --config string     config file (default is $HOME/.canvas-cli/config.yaml)
      --dry-run           Print curl commands instead of executing requests
      --filter string     Filter results by text (case-insensitive substring match)
      --instance string   Canvas instance URL (overrides config)
      --limit int         Limit number of results for list operations (0 = unlimited)
      --no-cache          Disable caching of API responses
  -o, --output string     Output format: table, json, yaml, csv (default "table")
      --quiet             Suppress informational messages, only output data and errors
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)
  -v, --verbose           Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 14-Jul-2026