update notification config info
PATCH https://api.suger.cloud/org/{orgId}/notificationConfigInfo
Update the notification config info of the given organization.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
Request Body
Required. 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 | Enable to email notification events to buyers |
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. |
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 | Enable to email notification events to buyers |
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
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.