Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

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

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

 

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.