News Feeds: Settings

The News Feed Settings service defines global settings across all the user's feeds. These settings are not specific to any other datapoint (such as schedules) even though they often affect multiple services.

  1. Supported Roles
  2. Available Services
    1. News Feed Settings
  3. News Feeds Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes
More information about roles may be found here.

Available Services

News Feed Settings

URI: /<API Version>/newsfeeds/settings

HTTP Method Description Conditional Notes
GET Retrieves the settings for the news feed resources. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates the news feed settings for the current user. No
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

{
    "D": {
        "Success": true,
        "Results": {
          "DefaultEvents": ["New", "OpenHouse", "Pending", "PriceChange", "Sold", "BackOnMarket", "Extension", "StatusChange"],
          "MlsDefaultEvents": ["New", "PriceChange", "Sold", "BackOnMarket", "Extension", "StatusChange"],
          "NotificationUI": "NewsFeed"
        }
    }
}

PUT Request

Request body:
{
    "D": {
      "DefaultEvents": ["New", "Pending"]
    }
}

PUT Response

The standard success/fail response is returned.

News Feeds: Settings Description

Attribute Data Type Writeable Required Description
DefaultEvents CharacterList Yes No The list of News Feed Events applied to news feeds whose Events attribute is null.
MlsDefaultEvents CharacterList Yes No The list of News Feed Events applied to news feeds whose Events attribute is null for users who have not set DefaultEvents.
Note: Only MLS level users may modify this setting.
NotificationUI Character No No The UI the user wishes to see when they load a link generated from their news feed delivered to them in a notification. Possible values are: NewsFeed (default), SavedSearch, and NotificationListings. Note that this can be overridden per contact with the NewsFeedNotificationUI attribute.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.