Update a Notification Template

patch

/api/v2/notification_templates/{id}/

Make a PUT or PATCH request to this resource to update this notification template. The following fields may be modified:

  • name: Name of this notification template. (string, required)
  • description: Optional description of this notification template. (string, default="")
  • organization: (id, required)
  • notification_type: (choice, required)
    • email: Email
    • grafana: Grafana
    • irc: IRC
    • mattermost: Mattermost
    • pagerduty: Pagerduty
    • rocketchat: Rocket.Chat
    • slack: Slack
    • twilio: Twilio
    • webhook: Webhook
  • notification_configuration: (json, default={})
  • messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : NotificationTemplate
Type: object
Show Source
Nested Schema : Messages
Type: object
Title: Messages
Optional custom messages for notification template.
Default Value: { }
Nested Schema : Notification configuration
Type: object
Title: Notification configuration
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : NotificationTemplate
Type: object
Show Source
Nested Schema : Messages
Type: object
Title: Messages
Optional custom messages for notification template.
Default Value: { }
Nested Schema : Notification configuration
Type: object
Title: Notification configuration
Back to Top