Skip to content

canvas appointment-groups create

canvas appointment-groups create

Create an appointment group

Synopsis

Create a new appointment group with time slots.

Examples:

canvas appointment-groups create --context course_123 --title "Office Hours"
canvas appointment-groups create --context course_123 --title "Project Reviews" --publish --participants-per-slot 1
canvas appointment-groups create [flags]

Options

      --address string              Location address
      --allow-observer              Allow observer sign-up
      --context strings             Context codes (e.g. course_123) — required
      --description string          Description
  -h, --help                        help for create
      --location string             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 immediately
      --sub-context strings         Sub-context codes (sections or group category)
      --title string                Title (required)
      --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