Skip to main content

update notification config info

PATCH 
/org/:orgId/notificationConfigInfo

Update the notification config info of the given organization.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Body

required

Notification config info

    oneOf

    allEmailNotificationScopes NotificationScope (string)[]

    Possible values: [``, CREATE.PRODUCT, UPDATE.PRODUCT, DELETE.PRODUCT, CREATE.OFFER, ACCEPT.OFFER, EXPIRE.OFFER, UPDATE.OFFER, DELETE.OFFER, CANCEL.OFFER, OPEN_EMAIL.OFFER, SUBMIT_APPROVAL_REQUEST.OFFER, REVIEW_APPROVAL_REQUEST.OFFER, NOTIFY_CONTACTS.OFFER, PENDING_ACCEPTANCE.OFFER, PENDING_PARTNER_ACTION.OFFER, EXPIRE_SOON.OFFER, NOTIFY.UNPURCHASED_OFFERS, CREATE.ENTITLEMENT, REINSTATE.ENTITLEMENT, SUSPEND.ENTITLEMENT, PENDING_CANCEL.ENTITLEMENT, CANCEL.ENTITLEMENT, UPDATE.ENTITLEMENT, METER.ENTITLEMENT, END_SOON.ENTITLEMENT, TERMINATE.ENTITLEMENT, NOTIFY.HEADLESS_ENTITLEMENTS, CREATE.FUNDING_APPLICATION, UPDATE.FUNDING_APPLICATION, APPROVE.FUNDING_APPLICATION, REJECT.FUNDING_APPLICATION, CREATE.API_CLIENT, DELETE.API_CLIENT, ROTATE_SECRET.API_CLIENT, MERGE.BUYER, CREATE.ORGANIZATION, UPDATE.ORGANIZATION, APPROVE.ORGANIZATION, CREATE.USER, ADD.USER, DELETE.USER, UPDATE.USER, CREATE.INTEGRATION, UPDATE.INTEGRATION, DELETE.INTEGRATION, CREATE.SUPPORT_TICKET, CLOSE.SUPPORT_TICKET, REOPEN.SUPPORT_TICKET, CREATE.WORKFLOW, UPDATE.WORKFLOW, DELETE.WORKFLOW, NEW_CLIENT_SIGNUP.NOTIFICATION_MESSAGE, DISBURSE.REVENUE_RECORD, COMPLETE.AUTO_SHARE_TASK, FAIL.AUTO_SHARE_TASK, ARCHIVE.REFERRAL, CREATE.REFERRAL, UPDATE.REFERRAL, ACCEPT.REFERRAL, REJECT.REFERRAL, PENDING_ACCEPTANCE.REFERRAL, APPROVE.REFERRAL, INBOUND.REFERRAL]

    All available email notification scopes for the organization. It is used to populate the UI.

    daysToExpireSoonOfferWorkflowNotification integer

    The number of days before offer expiration to trigger the workflow notification. Only applicable when EnableExpireSoonOfferWorkflowNotification is true. Default is 7 days if not specified.

    disableEmailNotificationOnOfferReady boolean

    Enable to email notification events to buyers

    emailNotificationScopeEventConfigs

    object

    The per-scope-event email notification configurations. The key is the NotificationScope (e.g., "CREATE.OFFER"). Each scope has its own independent config with enabled state, recipients, and optional template override.

    property name*

    EmailNotificationScopeEventConfig

    bccRecipients

    object[]

    The BCC email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • ccRecipients

    object[]

    The CC email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • enabled boolean

    Whether this specific scope is enabled for email notifications. When false, no emails are sent for events matching this scope.

    recipients

    object[]

    The TO email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • templateId string

    The ID of the notification template assigned to this scope. Empty string means no custom template -- use default.

    enableEmailNotification boolean

    Enable to email notification events to organization admins/editors. The default is false, and does not send emails to organization admins/editors.

    enableExpireSoonOfferWorkflowNotification boolean

    Enable to send workflow notifications when offers are expiring soon. The default is false, and does not send expire soon offer workflow notifications.

    enableWebhookNotification boolean

    Enable the product whitelist for the webhook notification. The default is false, and allow all the products notifications sent via webhook.

    supportSlackChannelID string

    ID of slack channel for suger customer support

    webhookProductWhitelist string[]

    The product whitelist (suger Product Id) for the webhook notification. If the product is not in the whitelist, the notification will be sent via webhook.

Responses​

OK

Schema

    allEmailNotificationScopes NotificationScope (string)[]

    Possible values: [``, CREATE.PRODUCT, UPDATE.PRODUCT, DELETE.PRODUCT, CREATE.OFFER, ACCEPT.OFFER, EXPIRE.OFFER, UPDATE.OFFER, DELETE.OFFER, CANCEL.OFFER, OPEN_EMAIL.OFFER, SUBMIT_APPROVAL_REQUEST.OFFER, REVIEW_APPROVAL_REQUEST.OFFER, NOTIFY_CONTACTS.OFFER, PENDING_ACCEPTANCE.OFFER, PENDING_PARTNER_ACTION.OFFER, EXPIRE_SOON.OFFER, NOTIFY.UNPURCHASED_OFFERS, CREATE.ENTITLEMENT, REINSTATE.ENTITLEMENT, SUSPEND.ENTITLEMENT, PENDING_CANCEL.ENTITLEMENT, CANCEL.ENTITLEMENT, UPDATE.ENTITLEMENT, METER.ENTITLEMENT, END_SOON.ENTITLEMENT, TERMINATE.ENTITLEMENT, NOTIFY.HEADLESS_ENTITLEMENTS, CREATE.FUNDING_APPLICATION, UPDATE.FUNDING_APPLICATION, APPROVE.FUNDING_APPLICATION, REJECT.FUNDING_APPLICATION, CREATE.API_CLIENT, DELETE.API_CLIENT, ROTATE_SECRET.API_CLIENT, MERGE.BUYER, CREATE.ORGANIZATION, UPDATE.ORGANIZATION, APPROVE.ORGANIZATION, CREATE.USER, ADD.USER, DELETE.USER, UPDATE.USER, CREATE.INTEGRATION, UPDATE.INTEGRATION, DELETE.INTEGRATION, CREATE.SUPPORT_TICKET, CLOSE.SUPPORT_TICKET, REOPEN.SUPPORT_TICKET, CREATE.WORKFLOW, UPDATE.WORKFLOW, DELETE.WORKFLOW, NEW_CLIENT_SIGNUP.NOTIFICATION_MESSAGE, DISBURSE.REVENUE_RECORD, COMPLETE.AUTO_SHARE_TASK, FAIL.AUTO_SHARE_TASK, ARCHIVE.REFERRAL, CREATE.REFERRAL, UPDATE.REFERRAL, ACCEPT.REFERRAL, REJECT.REFERRAL, PENDING_ACCEPTANCE.REFERRAL, APPROVE.REFERRAL, INBOUND.REFERRAL]

    All available email notification scopes for the organization. It is used to populate the UI.

    daysToExpireSoonOfferWorkflowNotification integer

    The number of days before offer expiration to trigger the workflow notification. Only applicable when EnableExpireSoonOfferWorkflowNotification is true. Default is 7 days if not specified.

    disableEmailNotificationOnOfferReady boolean

    Enable to email notification events to buyers

    emailNotificationScopeEventConfigs

    object

    The per-scope-event email notification configurations. The key is the NotificationScope (e.g., "CREATE.OFFER"). Each scope has its own independent config with enabled state, recipients, and optional template override.

    property name*

    EmailNotificationScopeEventConfig

    bccRecipients

    object[]

    The BCC email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • ccRecipients

    object[]

    The CC email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • enabled boolean

    Whether this specific scope is enabled for email notifications. When false, no emails are sent for events matching this scope.

    recipients

    object[]

    The TO email recipients for this scope.

  • Array [

    • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string

  • ]

    • templateId string

    The ID of the notification template assigned to this scope. Empty string means no custom template -- use default.

    enableEmailNotification boolean

    Enable to email notification events to organization admins/editors. The default is false, and does not send emails to organization admins/editors.

    enableExpireSoonOfferWorkflowNotification boolean

    Enable to send workflow notifications when offers are expiring soon. The default is false, and does not send expire soon offer workflow notifications.

    enableWebhookNotification boolean

    Enable the product whitelist for the webhook notification. The default is false, and allow all the products notifications sent via webhook.

    supportSlackChannelID string

    ID of slack channel for suger customer support

    webhookProductWhitelist string[]

    The product whitelist (suger Product Id) for the webhook notification. If the product is not in the whitelist, the notification will be sent via webhook.

Loading...