Preview

updateNotificationTemplate is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

updateNotificationTemplate

Updates the subject line and main content for notifications of a specified type.

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    Arguments

    input UpdateNotificationTemplateInput! PREVIEW

    Input used to update a specific notification template.

    UpdateNotificationTemplateInput fields

    method NotificationDeliveryMethod!

    Method used for notification can be EMAIL or SMS.

    type NotificationType!

    The type of notification (this generally corresponds to an event or an action).

    id ID!

    The unique identifier of the notification template.

    subject String!

    The message subject line for the notification template.

    content String!

    The main content of the notification template.

    name String

    A name for the notification template. This name appears in the marketplace UI.

    Return Fields

    success Boolean

    Whether the notification template update operation was successful.

    errors [UpdateNotificationTemplateError!] PREVIEW

    Details about errors that were thrown while updating a notification template

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.