> For the complete documentation index, see [llms.txt](https://api-docs.realfinity.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.realfinity.io/api/api-reference/notification-settings.md).

# Notification Settings

Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan applications, each level able to override. Values are resolved most-specific-first and every effective value reports which level supplied it. Mirrors the Private API's routes and contract.

## GET /notification-settings/catalog

> The notification catalog

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Notification Settings","description":"Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan\r\napplications, each level able to override. Values are resolved most-specific-first and every\r\neffective value reports which level supplied it. Mirrors the Private API's routes and contract."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/notification-settings/catalog":{"get":{"tags":["Notification Settings"],"summary":"The notification catalog","responses":{"200":{"description":"The notification catalog.","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogResponse"}}}},"401":{"description":"Unauthorized"}}}}},"components":{"schemas":{"Realfinity.Common.Models.Notifications.NotificationCatalogResponse":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogEntry"},"nullable":true},"milestones":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationCatalogMilestones"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.NotificationCatalogEntry":{"type":"object","properties":{"templateKey":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"recipientTypes":{"type":"array","items":{"type":"string"},"nullable":true},"itemKey":{"type":"string","nullable":true,"readOnly":true},"displayName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"agentDelivery":{"type":"string","nullable":true,"readOnly":true},"milestone":{"type":"string","nullable":true},"defaultEnabled":{"type":"boolean"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.NotificationCatalogMilestones":{"type":"object","properties":{"client":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.MilestoneSummary"},"nullable":true},"user":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.MilestoneSummary"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.MilestoneSummary":{"type":"object","properties":{"code":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"},"itemKeys":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}}}}
```

## GET /notification-settings/{entityType}/{entityId}

> Effective notification settings for an entity

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Notification Settings","description":"Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan\r\napplications, each level able to override. Values are resolved most-specific-first and every\r\neffective value reports which level supplied it. Mirrors the Private API's routes and contract."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/notification-settings/{entityType}/{entityId}":{"get":{"tags":["Notification Settings"],"summary":"Effective notification settings for an entity","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Effective settings.","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}}}},"400":{"description":"Unknown entity type or entity."},"401":{"description":"Unauthorized"},"404":{"description":"The entity could not be found."}}}}},"components":{"schemas":{"Realfinity.Common.Models.Notifications.EffectiveNotificationSettings":{"type":"object","properties":{"entityType":{"type":"string","nullable":true},"entityId":{"type":"string","format":"uuid"},"categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveCategory"},"nullable":true},"override":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.NotificationSettingsDocument"},"permissions":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationPermissions"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveCategory":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveBranch"},"user":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveBranch"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveBranch":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"nullable":true},"items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveValue":{"type":"object","properties":{"enabled":{"type":"boolean"},"source":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.NotificationSettingsDocument":{"type":"object","properties":{"id":{"type":"string","nullable":true},"partitionKey":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"entityId":{"type":"string","format":"uuid"},"companyId":{"type":"string","format":"uuid","nullable":true},"categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.CategorySettings"},"nullable":true},"updatedBy":{"type":"string","format":"uuid","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"_etag":{"type":"string","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.CategorySettings":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch"},"user":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch"}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true},"items":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"milestones":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"knownTemplates":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveNotificationPermissions":{"type":"object","properties":{"canEdit":{"type":"boolean"}},"additionalProperties":false}}}}
```

## PATCH /notification-settings/{entityType}/{entityId}

> Change notification settings for an entity

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Notification Settings","description":"Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan\r\napplications, each level able to override. Values are resolved most-specific-first and every\r\neffective value reports which level supplied it. Mirrors the Private API's routes and contract."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/notification-settings/{entityType}/{entityId}":{"patch":{"tags":["Notification Settings"],"summary":"Change notification settings for an entity","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/json-patch+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}},"application/*+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation"}}}}},"responses":{"200":{"description":"Effective settings after the change.","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationSettings"}}}},"400":{"description":"Invalid path, unknown template, or a non-configurable category."},"401":{"description":"Unauthorized"},"404":{"description":"The entity could not be found."},"409":{"description":"The settings changed underneath the request; retry."}}}}},"components":{"schemas":{"Realfinity.Common.Models.Notifications.NotificationSettingsPatchOperation":{"type":"object","properties":{"path":{"type":"string","nullable":true},"value":{"type":"boolean","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveNotificationSettings":{"type":"object","properties":{"entityType":{"type":"string","nullable":true},"entityId":{"type":"string","format":"uuid"},"categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveCategory"},"nullable":true},"override":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.NotificationSettingsDocument"},"permissions":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveNotificationPermissions"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveCategory":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveBranch"},"user":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveBranch"}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveBranch":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"nullable":true},"items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.Notifications.EffectiveValue"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveValue":{"type":"object","properties":{"enabled":{"type":"boolean"},"source":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.NotificationSettingsDocument":{"type":"object","properties":{"id":{"type":"string","nullable":true},"partitionKey":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"entityId":{"type":"string","format":"uuid"},"companyId":{"type":"string","format":"uuid","nullable":true},"categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.CategorySettings"},"nullable":true},"updatedBy":{"type":"string","format":"uuid","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"_etag":{"type":"string","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.CategorySettings":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch"},"user":{"$ref":"#/components/schemas/Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch"}},"additionalProperties":false},"Realfinity.Common.Models.CosmosDb.NotificationSettings.RecipientBranch":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true},"items":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"milestones":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"knownTemplates":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Notifications.EffectiveNotificationPermissions":{"type":"object","properties":{"canEdit":{"type":"boolean"}},"additionalProperties":false}}}}
```

## POST /notification-settings/client/{clientId}/apply-to-loans

> Apply a client's notification defaults to their loan applications

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Notification Settings","description":"Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan\r\napplications, each level able to override. Values are resolved most-specific-first and every\r\neffective value reports which level supplied it. Mirrors the Private API's routes and contract."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/notification-settings/client/{clientId}/apply-to-loans":{"post":{"tags":["Notification Settings"],"summary":"Apply a client's notification defaults to their loan applications","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The ids of the removed override documents."},"401":{"description":"Unauthorized"},"404":{"description":"The client could not be found."}}}}}}
```

## POST /notification-settings/user/{userId}/apply-to-clients

> Apply a user's notification defaults to their clients and loans

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Notification Settings","description":"Hierarchical notification preferences: user defaults, inherited by clients, inherited by loan\r\napplications, each level able to override. Values are resolved most-specific-first and every\r\neffective value reports which level supplied it. Mirrors the Private API's routes and contract."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/notification-settings/user/{userId}/apply-to-clients":{"post":{"tags":["Notification Settings"],"summary":"Apply a user's notification defaults to their clients and loans","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The ids of the removed override documents."},"401":{"description":"Unauthorized"},"404":{"description":"The user could not be found."}}}}}}
```