Settings

Update notification settings

Changed on

Update the organization's notification preferences. These are org-wide, so the change applies to every brand in the organization. All fields optional; only provided fields change. reportRecipients replaces the client-report recipient list (each entry: email + weekly/monthly/whiteLabel booleans + teamIds + an optional per-brand reports map + an optional schedule: sendTime, timeZone, weeklyDay, monthlyDay). defaultReportTemplateSlug sets the template used when a recipient has no per-brand choice. reportLinkPassword gates the hosted report links. weeklyReportTeamIds / monthlyAuditTeamIds scope the org's own reports to specific brands; omit or send null for all brands.

patch/v3/settings/notifications

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/settings/notifications
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

teamIdstring
weeklyReportsboolean
monthlyAuditsboolean
newOpportunitiesboolean
resourceUsageWarningboolean
clientReportsEnabledboolean
weeklyReportTeamIdsstring[] nullable

Brands the weekly report covers. Null or omitted means all brands.

monthlyAuditTeamIdsstring[] nullable

Brands the monthly audit covers. Null or omitted means all brands.

defaultReportTemplateSlugstring nullable

Template slug client reports fall back to. Null resets to the built-in default template.

Response

Default Response

weeklyReportsboolean
monthlyAuditsboolean
weeklyReportTeamIdsstring[] nullable
monthlyAuditTeamIdsstring[] nullable
newOpportunitiesboolean
resourceUsageWarningboolean
clientReportsEnabledboolean
reportRecipientsobject[]
defaultReportTemplateSlugstring nullable
reportLinkPasswordobject nullable
whiteLabelAvailableboolean

Changes