Jump to content

Community

REST API Documentation

/core/members/{id}/follows


Store a new follow for the member

Parameters

Name Type Description
Required followApp string Application of the content to follow
Required followArea string Area of the content to follow
Required followId int ID of the content to follow
followAnon bool Whether or not to follow anonymously
followNotify bool Whether or not to receive notifications
followType string Type of notification to receive (immediate=send a notification immediately, daily=daily notification digest, weekly=weekly notification digest)

Exceptions

Code Message Description
2C292/G NO_PERMISSION The authorized user does not have permission to view the follows
2C292/H INVALID_ID The member could not be found
2C292/J INVALID_CONTENT The app, area or content ID could not be found

Response

Name Type Description
followKey int Unique key that represents the follow
followApp string The application of the content that was followed
followArea string The area of the content that was followed
followId int The ID of the content that was followed
followAnon bool Flag to indicate if the member is following anonymously
followNotify bool Flag to indicate if notifications should be sent
followType tring|null object Notification preference for this follow, or null if notifications are not being sent
followSent atetime|null object Date and time the last notification was sent, or NULL if none has been sent
followName string Textual representation of the content that was followed (title, name, etc.)
followUrl string URL to the content that was followed
×
×
  • Create New...