Skip to content

canvas groups create

canvas groups create

Create a new group

Synopsis

Create a new group in a group category.

Examples:

canvas groups create --category-id 123 --name "Study Group"
canvas groups create --category-id 123 --name "Project Team" --description "Our project team"
canvas groups create [flags]

Options

      --category-id int        Group category ID (required)
      --description string     Group description
  -h, --help                   help for create
      --join-level string      Join level (parent_context_auto_join, parent_context_request, invitation_only)
      --name string            Group name (required)
      --public                 Whether the group is public
      --sis-group-id string    SIS group ID
      --storage-quota-mb int   Storage quota in MB

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")
      --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 25-Jan-2026