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 Origins 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
FloPlan
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 Feed: Templates

News feed templates customize the subject and body of e-mails delivered from newsfeed notificatoins.

 
  1. Supported Roles
  2. Available Services
    1. Newsfeed Template
  3. Template Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW (As Portal Group) Yes Yes
Portal (As Portal Group) Yes Yes
Private Yes Yes

More information about roles may be found here.

 

Available Services

Newsfeed Template

/<API Version>/newsfeeds/<NewsFeed.Id>/template
/<API Version>/contacts/<Contact.Id>/newsfeeds/<NewsFeed.Id>/template

HTTP Method Description Conditional Notes
GET Returns the user's newsfeed template, if it exists. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates the user's template for a given newsfeed. No
DELETE Deletes the custom template for a given newsfeed. No

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
              "Id": "20100000000000000000000000",
              "ResourceUri": "/vX/newsfeeds/20100000000000000000000001/template",
              "NewsfeedId": "20100000000000000000000001",
              "OwnerId": "20100000000000000000000002",
              "OwnerType": "Member",
              "Subject": "My Very Special Subject",
              "Body": "My Very Special Message Body",
              "TemplateId": null,
              "ModificationTimestamp": "2013-07-07T12:12:06-05:00"
            }
        ]
    }
}
 

PUT Request

Request body:

{
    "D": {
      "Subject": "My Very Special Subject",
      "Body": "My Very Special Message Body",
    }
}
 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Schedules Description

Attribute Data Type Writeable Required Description
ResourceUri Character No No The URI to the news feed template.
Id Character No No The unique id for the template.
NewsfeedId Character No No The Id of the newsfeed this template is for.
OwnerId Character No No The Id of the user or contact who owns the template.
OwnerType Character No No The type of user that owns the notification.
Subject Character Yes Yes The custom e-mail subject (100 character maximum).
Body Character Yes Yes The custom e-mail body (3000 character maximum).
TemplateId Character Yes No The Id of the template to use to supply the subject and body. If supplied, Subject and Body must be null.
ModificationTimestamp Timestamp No No The date and time the template was last modified.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.