Sign in
Settings

Update notification settings

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 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

Changes

Changed in 4 of the 47 revisions of this API.28

  • e0163b1c37cb11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    • ○

      endpoint added

      endpoint-added

  • ad15b6b0845b3See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

  • 5c54912ec4f73See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 60ff6690f93c11See the full diff
    • ▲

      added required request body

      request-body-added-required

    • ○

      api tag Settings added

      api-tag-added