Difference between revisions of "CRM-2 Social API"
m (→Thumb Up and Thumb Down) |
m (→Thumb Up and Thumb Down) |
||
| Line 30: | Line 30: | ||
Parameters: | Parameters: | ||
* parentNoteId : id of the activity for which to record a thumb-up or thumb-down | * parentNoteId : id of the activity for which to record a thumb-up or thumb-down | ||
| − | * userId : id of the user that | + | * userId : id of the user that voted on the activity |
Note: only one of those action is active for a given user and activity, if the user thumb-up then thumb-down his thumb-up is deleted. | Note: only one of those action is active for a given user and activity, if the user thumb-up then thumb-down his thumb-up is deleted. | ||
Revision as of 07:31, 20 March 2015
The social API allows you to record social interactions of your customers, such as views, likes (faves), votes for and against, and comments. They can be related to other activities or to other nodes, such as web pages or blog posts. The API does not include the user interface but is meant to be called from the user interface to record the interactions.
Contents
Views
Records or retrieves the number of times the activity has been viewed.
Method: POST, URL extension: /social/view
Parameters:
- parentNoteId : id of the activity for which to record a view
- userId : id of the user that viewed the activity
Like
Records or retrieves the likes or faves of an activity.
Method: POST, URL extension: /social/like
Parameters:
- parentNoteId : id of the activity for which to record a like
- userId : id of the user that viewed the activity
Thumb Up and Thumb Down
Records and retrieves votes either for or against.
Method: POST, URL extension: /social/thumb-up Method: POST, URL extension: /social/thumb-down
Parameters:
- parentNoteId : id of the activity for which to record a thumb-up or thumb-down
- userId : id of the user that voted on the activity
Note: only one of those action is active for a given user and activity, if the user thumb-up then thumb-down his thumb-up is deleted.
Comments
Records comments. A comment is first created in the pending state and will be emailed to the domain administrator (user with DOMAIN_CONF permission), who needs to approve or reject the comment. Only approved comments will be retrieved for display.
