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

News Feed Groups are collections of news feeds that are all subscribed to the same subscription and have identical notification schedules.

Alpha Only: This service is subject to change

This service is a work in progress. It is currently subject to change or removal without notice.

Supported Roles
Available Services
News Feed Groups Description
Expansions

Supported Roles

Role	Reads	Writes
IDX	No	No
Public	No	No
VOW	No	No
Portal	No	No
Private	Yes	Yes

More information about roles may be found here.

Available Services

All News Feed Groups

`/<API Version>/newsfeeds/groups`

HTTP Method	Description	Conditional	Notes
GET	Returns all news feed groups	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
Standard search and paging syntax	No
Standard expansion parameters	No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Id": "20130625195235039712000000",
            "Name": "My Newsfeed Group Name",
            "Type": "SavedSearch",
            "NotifyOnOpen": false,
            "SendAgentCopy": true,
            "Subscription": {
              "ResourceUri": "/vX/savedsearches/20100815220615294367000000",
              "Id":  "20100815220615294367000000",
              "OwnerId": "20090815223215294334000000",
              "Name": "Search name here",
              "Description": "A longer description of the search",
              "Filter": null,
              "ModificationTimestamp": "2011-03-14T08:39:38-05:00"
            }
          }
        ]
    }
}

Individual News Feed Group

`/<API Version>/newsfeeds/groups/<NewsFeedGroup.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Deletes all news feeds in a group, and all of their events	No	Each feed is queued for deletion, and is immediately set to `Active: false`.

DELETE Request

Parameters:

None

DELETE Response

The standard 'accepted for processing' response is returned.

All News Feed Groups with Contact Subscribers

`/<API Version>/contacts/newsfeeds/groups`

HTTP Method	Description	Conditional	Notes
GET	Returns news feed groups that have at least one feed where a contact is a subscriber	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
Standard search and paging syntax	No
Standard expansion parameters	No

GET Response

See the GET request section for for the news feed groups service.

Batch Updates

`/<API Version>/newsfeeds/groups`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Updates the provided attributes for all specified groups	No	`Id` must be present in each record to specify which records will be updated. Unspecified records will not be modified. 500 record limit per batch.
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

PUT Request

Request body:

{
    "D": [
       {"Id": "20190730122640779278000000", "NotifyOnOpen": false},
       {"Id": "20190730122646093880000000", "NotifyOnOpen": false},
       {"Id": "20190730122652255537000000", "NotifyOnOpen": true},
       {"Id": "20190730122657842349000000", "NotifyOnOpen": false}
    ]
}

PUT Response

The standard success/fail response is returned.

News Feed Group Description

Attribute	Data Type	Writeable	Required	Searchable	Description
`Id`	Character	No	No	No	The unique id for the news feed group.
`Name`	Character	No	No	Yes	The custom name for the news feed group.
`Type`	Character	No	No	Yes	The type of data the news feed subscription is for.
`NotifyOnOpen`	Boolean	Yes	No	No	If `true`, when a contact opens the link to a news feed in the group, the agent they belong to will be notified.
`SendAgentCopy`	Boolean	Yes	No	No	If `true`, when a contact is sent a notification for a news feed in the group, the agent they belong to will also be notified.
`"NewsFeeds"."Active"`	Boolean	No	No	Yes	When used as part of the `_filter`, only groups with at least one active (`"NewsFeeds"."Active" Eq true`), or inactive (`"NewsFeeds"."Active" Eq false`), feed will be returned.
`Subscription`	JSON Object			Yes	The resource the news feed subscription is for (for example, a Saved Search record). Searchable by `"Subscription"."Id"`.

Expansions

Expansion	Roles	Single Record Only?	Selection Support?	Description
`NewsFeeds`	Private	No	No	A list of news feed subscriptions the current user has for this search.