Skip to content

canvas announcements create

canvas announcements create

Create a new announcement

Synopsis

Create a new announcement in a course.

Examples:

canvas announcements create --course-id 123 --title "Welcome to the Course!"
canvas announcements create --course-id 123 --title "Important Update" --message "<p>Please read...</p>"
canvas announcements create --course-id 123 --title "Scheduled" --delayed-at "2024-12-01T09:00:00Z"
canvas announcements create [flags]

Options

      --course-id int       Course ID (required)
      --delayed-at string   Delay posting until (ISO 8601)
  -h, --help                help for create
      --message string      Announcement message (HTML)
      --published           Publish the announcement (default: true) (default true)
      --title string        Announcement title (required)

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