Skip to main content

Message Templates

This category lists the 6 Runtime system commands under system.message..

1. List templates​

Full name: system.message.template.list

List message template records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system message template list \
  [--keyword value] [--status draft|active] [--exclude-builtin] \
  [--cursor value] [--limit n] [--json]

Parameters:

  • keyword（optional）— Case-insensitive template name/code filter
  • status（optional）— Optional draft or active filter
  • includeBuiltin（optional）— Include read-only built-in templates; defaults to true
  • cursor（optional）— Opaque cursor returned by the previous list call
  • limit（optional）— Maximum items to return from 1 to 100; defaults to 20

2. Retrieve template​

Full name: system.message.template.get

Retrieve message template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system message template get --template-id <uuid> [--json]

Parameters:

  • templateId（required）— Existing template UUID returned by template list

3. Create template​

Full name: system.message.template.create

Create message template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system message template create \
  (--definition-json json|--definition-file path) [--json]

Parameters:

  • definition（required）— Complete draft authoring definition described by templateConfiguration

4. Update template​

Full name: system.message.template.update

Update message template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system message template update \
  --template-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

Parameters:

  • templateId（required）— Existing non-built-in template UUID
  • definition（required）— Complete replacement authoring definition described by templateConfiguration

5. Activate template​

Full name: system.message.template.activate

Activate message template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system message template activate --template-id <uuid> [--json]

Parameters:

  • templateId（required）— Complete non-built-in template UUID to activate

6. Delete template​

Full name: system.message.template.delete

Delete message template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system message template delete \
  --template-id <uuid> [--force] [--json]

Parameters:

  • templateId（required）— Existing non-built-in template UUID
  • force（optional）— Delete despite active approval/open-link references; defaults to false