News Feed: Templates
News feed templates customize the subject and body of e-mails delivered from newsfeed notificatoins.
- Supported Roles
- Available Services
- Newsfeed Template
- Template Description
- Expansions
- API Explorer
Supported Roles
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.