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


OptOut notifications for given notification delivery method, notification types and target

This page contains

    Authorization Rules

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




    input CreateNotificationOptOutInput! PREVIEW

    Input object to create notification opt out

    CreateNotificationOptOutInput fields

    method NotificationDeliveryMethod!

    Method used for notification Delivery can be EMAIL or SMS

    types [NotificationType!]!

    Array of Notification types for which opt outs to be created for given target

    target String!

    Target can be an email address for EMAIL delivery method or phone number for SMS delivery method

    Return Fields

    success Boolean

    Indicates success of notification optout creation operation

    errors [CreateNotificationOptOutError!] PREVIEW

    Error details while creating notification optouts

    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.