Get Notification Config Info

GET https://api.suger.cloud/org/{orgId}/notificationConfigInfo

Get the notification config info of the given organization.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID

Responses

200 — OK

Content-Type: application/json · Schema: NotificationConfigInfo

NotificationConfigInfo fields:

Field	Type	Required	Description
`allEmailNotificationScopes`	array<NotificationScope>	no	All available email notification scopes for the organization. It is used to populate the UI.
`crmFieldOptionsByCrm`	object	no	CrmFieldOptionsByCrm is a read-only capability map keyed by CrmSource. Per-org integration-filtered: only CRM keys whose service=CRM integration exists for the org are emitted. Drives the FE's "+ Add dynamic recipient ▾ → Salesforce / HubSpot ▸" branches. Ignored on inbound (PATCH) requests.
`daysToExpireSoonOfferWorkflowNotification`	integer	no	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.
`defaultSenderEmail`	string	no	DefaultSenderEmail is the read-only "from" address used when a scope has no custom sender (the default Suger SES no-reply address, e.g. "no-reply@suger.cloud"). Set by the GetNotificationConfigInfo handler from the environment's SES domain so the FE can show the concrete address. Ignored on inbound (PATCH) requests.
`disableEmailNotificationOnOfferReady`	boolean	no	Deprecated: retired control with no readers. It was the off-switch for the automatic offer-ready / resale-authorization-active contact emails; under config-governed enforcement (sugerio/artifacts:designs/email-config-enforcement) those emails are the PENDING_ACCEPTANCE.OFFER and ACTIVE.OFFER rows, governed by their toggle and recipients. Kept only so stored organization JSON keeps round-tripping; delete after post-cutover burn-in.
`emailNotificationScopeEventConfigs`	object	no	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.
`enableEmailNotification`	boolean	no	Enable to email notification events to organization admins/editors. The default is false, and does not send emails to organization admins/editors.
`enableExpireSoonOfferWorkflowNotification`	boolean	no	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	no	Enable the product whitelist for the webhook notification. The default is false, and allow all the products notifications sent via webhook.
`entityFieldOptions`	object	no	EntityFieldOptions is a read-only capability map keyed by EntityType. Set by the GetNotificationConfigInfo handler from the package constant EntityFieldOptionsByEntityType. Drives the FE's "+ Add dynamic recipient ▾ → Offer ▸" branch. Ignored on inbound (PATCH) requests.
`roleGroupOptionsByEntityType`	object	no	RoleGroupOptionsByEntityType is a read-only capability map keyed by EntityType. Set by the GetNotificationConfigInfo handler from the package constant RoleGroupOptionsByEntityType. Drives the FE's "+ Add dynamic recipient ▾ → Role Group ▸" branch. Ignored on inbound (PATCH) requests.
`supportSlackChannelID`	string	no	ID of slack channel for suger customer support
`webhookProductWhitelist`	array<string>	no	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.

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/org/{orgId}/notificationConfigInfo' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "allEmailNotificationScopes": [
    ""
  ],
  "crmFieldOptionsByCrm": {},
  "daysToExpireSoonOfferWorkflowNotification": 1,
  "defaultSenderEmail": "buyer@example.com",
  "disableEmailNotificationOnOfferReady": true,
  "emailNotificationScopeEventConfigs": {},
  "enableEmailNotification": true,
  "enableExpireSoonOfferWorkflowNotification": true,
  "enableWebhookNotification": true,
  "entityFieldOptions": {},
  "roleGroupOptionsByEntityType": {},
  "supportSlackChannelID": "01H0000000000000000000"
}

Error — 400

"string"

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.