Read a brand’s notification preferences — weekly reports, monthly audits, new opportunities, resource-usage warnings — plus the list of client-report recipients and the cadence each one receives.
Reading requires any team member. The GET route auto-creates default settings on first read.
GET response fields
Each entry in reportRecipients has:
Update Notification Settings
PATCH /v3/settings/notifications
Update any subset of the fields above. Only the keys you send are changed; the merged, canonical settings are returned.
Writing requires managed (admin/owner) access to the brand.
reportRecipients is sanitized on write: emails are trimmed, lowercased, and deduplicated; entries with an invalid email or with both weekly and monthly off are dropped; and the list is capped at 10 recipients. whiteLabelAvailable is read-only and ignored if sent.
