PUT api/Notifications/NotificationSettings

Updates the globally configured notification settings

Request Information

URI Parameters

None.

Body Parameters

The updated NotificationSettings model (profiles must be list of user ids, not objects)

WorkPoint.Core.Models.Notification.NotificationSettings

Name	Type	Additional information
Enabled	boolean	None.
NotificationPriorityTermSetId	globally unique identifier	None.
NotificationTypeTermSetId	globally unique identifier	None.
IsAutomaticDeletionEnabled	boolean	None.
RetentionPeriodInDays	integer	None.
OnlyCleanupCompletedNotifications	boolean	None.
IsCustomizedAdaptiveCardLayoutEnabled	boolean	None.
CustomizedAdaptiveCardLayoutJson	string	None.
NotificationProfiles	Collection of WorkPoint.Core.Models.Notification.NotificationSettings+NotificationProfile	None.
NotificationTeamsAppSettings	WorkPoint.Core.Models.Notification.NotificationTeamsAppSettings	None.

Request Formats

application/json, text/json

Sample:

{
  "Enabled": true,
  "NotificationPriorityTermSetId": "f51f822c-115c-4816-a395-e4940b9daff0",
  "NotificationTypeTermSetId": "720b7193-8ac5-4b9c-9534-4c7fff930f38",
  "IsAutomaticDeletionEnabled": true,
  "RetentionPeriodInDays": 3,
  "OnlyCleanupCompletedNotifications": true,
  "IsCustomizedAdaptiveCardLayoutEnabled": true,
  "CustomizedAdaptiveCardLayoutJson": "sample string 6",
  "NotificationProfiles": [
    {
      "Id": "600aa06b-34aa-48f4-a3b9-6558ff6a63d2",
      "Name": "sample string 2",
      "Target": {
        "Identifier": "sample string 1",
        "Name": "sample string 2"
      },
      "EmailSchedule": 0,
      "DeliveryDayOfWeek": 0,
      "SpecificDeliveryTime": "00:00:00.1234567",
      "NotificationTypes": [
        {
          "ManagedMetadataName": "sample string 1",
          "ParentManagedMetadataName": "sample string 2",
          "ManagedMetadataId": "6b44b346-0c92-4ced-8602-e09c7d42e36e",
          "ParentManagedMetadataId": "254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa",
          "Enable": true,
          "EnableEmail": true,
          "EnableTeams": true,
          "IsLocked": true
        },
        {
          "ManagedMetadataName": "sample string 1",
          "ParentManagedMetadataName": "sample string 2",
          "ManagedMetadataId": "6b44b346-0c92-4ced-8602-e09c7d42e36e",
          "ParentManagedMetadataId": "254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa",
          "Enable": true,
          "EnableEmail": true,
          "EnableTeams": true,
          "IsLocked": true
        }
      ]
    },
    {
      "Id": "600aa06b-34aa-48f4-a3b9-6558ff6a63d2",
      "Name": "sample string 2",
      "Target": {
        "Identifier": "sample string 1",
        "Name": "sample string 2"
      },
      "EmailSchedule": 0,
      "DeliveryDayOfWeek": 0,
      "SpecificDeliveryTime": "00:00:00.1234567",
      "NotificationTypes": [
        {
          "ManagedMetadataName": "sample string 1",
          "ParentManagedMetadataName": "sample string 2",
          "ManagedMetadataId": "6b44b346-0c92-4ced-8602-e09c7d42e36e",
          "ParentManagedMetadataId": "254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa",
          "Enable": true,
          "EnableEmail": true,
          "EnableTeams": true,
          "IsLocked": true
        },
        {
          "ManagedMetadataName": "sample string 1",
          "ParentManagedMetadataName": "sample string 2",
          "ManagedMetadataId": "6b44b346-0c92-4ced-8602-e09c7d42e36e",
          "ParentManagedMetadataId": "254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa",
          "Enable": true,
          "EnableEmail": true,
          "EnableTeams": true,
          "IsLocked": true
        }
      ]
    }
  ],
  "NotificationTeamsAppSettings": {
    "AppId": "eb056e89-2b72-40d6-bae9-52d7986101f0",
    "AppShortName": "sample string 1",
    "AppFullName": "sample string 2",
    "AppShortDescription": "sample string 3",
    "AppFullDescription": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<NotificationSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.Notification">
  <CustomizedAdaptiveCardLayoutJson>sample string 6</CustomizedAdaptiveCardLayoutJson>
  <Enabled>true</Enabled>
  <IsAutomaticDeletionEnabled>true</IsAutomaticDeletionEnabled>
  <IsCustomizedAdaptiveCardLayoutEnabled>true</IsCustomizedAdaptiveCardLayoutEnabled>
  <NotificationPriorityTermSetId>f51f822c-115c-4816-a395-e4940b9daff0</NotificationPriorityTermSetId>
  <NotificationProfiles>
    <NotificationSettings.NotificationProfile>
      <DeliveryDayOfWeek>Sunday</DeliveryDayOfWeek>
      <EmailSchedule>SendImmediatetly</EmailSchedule>
      <Id>600aa06b-34aa-48f4-a3b9-6558ff6a63d2</Id>
      <Name>sample string 2</Name>
      <NotificationTypes>
        <NotificationSettings.NotificationProfileNotificationTypes>
          <Enable>true</Enable>
          <EnableEmail>true</EnableEmail>
          <EnableTeams>true</EnableTeams>
          <IsLocked>true</IsLocked>
          <ManagedMetadataId>6b44b346-0c92-4ced-8602-e09c7d42e36e</ManagedMetadataId>
          <ManagedMetadataName>sample string 1</ManagedMetadataName>
          <ParentManagedMetadataId>254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa</ParentManagedMetadataId>
          <ParentManagedMetadataName>sample string 2</ParentManagedMetadataName>
        </NotificationSettings.NotificationProfileNotificationTypes>
        <NotificationSettings.NotificationProfileNotificationTypes>
          <Enable>true</Enable>
          <EnableEmail>true</EnableEmail>
          <EnableTeams>true</EnableTeams>
          <IsLocked>true</IsLocked>
          <ManagedMetadataId>6b44b346-0c92-4ced-8602-e09c7d42e36e</ManagedMetadataId>
          <ManagedMetadataName>sample string 1</ManagedMetadataName>
          <ParentManagedMetadataId>254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa</ParentManagedMetadataId>
          <ParentManagedMetadataName>sample string 2</ParentManagedMetadataName>
        </NotificationSettings.NotificationProfileNotificationTypes>
      </NotificationTypes>
      <SpecificDeliveryTime>PT0.1234567S</SpecificDeliveryTime>
      <Target>
        <Identifier>sample string 1</Identifier>
        <Name>sample string 2</Name>
      </Target>
    </NotificationSettings.NotificationProfile>
    <NotificationSettings.NotificationProfile>
      <DeliveryDayOfWeek>Sunday</DeliveryDayOfWeek>
      <EmailSchedule>SendImmediatetly</EmailSchedule>
      <Id>600aa06b-34aa-48f4-a3b9-6558ff6a63d2</Id>
      <Name>sample string 2</Name>
      <NotificationTypes>
        <NotificationSettings.NotificationProfileNotificationTypes>
          <Enable>true</Enable>
          <EnableEmail>true</EnableEmail>
          <EnableTeams>true</EnableTeams>
          <IsLocked>true</IsLocked>
          <ManagedMetadataId>6b44b346-0c92-4ced-8602-e09c7d42e36e</ManagedMetadataId>
          <ManagedMetadataName>sample string 1</ManagedMetadataName>
          <ParentManagedMetadataId>254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa</ParentManagedMetadataId>
          <ParentManagedMetadataName>sample string 2</ParentManagedMetadataName>
        </NotificationSettings.NotificationProfileNotificationTypes>
        <NotificationSettings.NotificationProfileNotificationTypes>
          <Enable>true</Enable>
          <EnableEmail>true</EnableEmail>
          <EnableTeams>true</EnableTeams>
          <IsLocked>true</IsLocked>
          <ManagedMetadataId>6b44b346-0c92-4ced-8602-e09c7d42e36e</ManagedMetadataId>
          <ManagedMetadataName>sample string 1</ManagedMetadataName>
          <ParentManagedMetadataId>254a0c9e-ec8b-4eb5-9e88-c81aae8ec6fa</ParentManagedMetadataId>
          <ParentManagedMetadataName>sample string 2</ParentManagedMetadataName>
        </NotificationSettings.NotificationProfileNotificationTypes>
      </NotificationTypes>
      <SpecificDeliveryTime>PT0.1234567S</SpecificDeliveryTime>
      <Target>
        <Identifier>sample string 1</Identifier>
        <Name>sample string 2</Name>
      </Target>
    </NotificationSettings.NotificationProfile>
  </NotificationProfiles>
  <NotificationTeamsAppSettings>
    <AppFullDescription>sample string 4</AppFullDescription>
    <AppFullName>sample string 2</AppFullName>
    <AppId>eb056e89-2b72-40d6-bae9-52d7986101f0</AppId>
    <AppShortDescription>sample string 3</AppShortDescription>
    <AppShortName>sample string 1</AppShortName>
  </NotificationTeamsAppSettings>
  <NotificationTypeTermSetId>720b7193-8ac5-4b9c-9534-4c7fff930f38</NotificationTypeTermSetId>
  <OnlyCleanupCompletedNotifications>true</OnlyCleanupCompletedNotifications>
  <RetentionPeriodInDays>3</RetentionPeriodInDays>
</NotificationSettings>

Response Information

Resource Description

true if updated

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.