Allows a user to subscribe to a comments stream by email notification.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer toREST API > comments.subscribe.
The following table lists the available parameters:
lang string The language to be used by comment email templates for comment stream subscription emails and comment reply notification emails.
|||categoryID||string||The identifier of the comment category to which the user subscribes.|
|||streamID||string||The identifier of the comment stream to which the user subscribes.|
|||string||The email address to which to send the notification. If the user is a guest, then this field is Required. If the user is logged in this email address overrides the address stored in the userOptions object (see comments.setUserOptions).|
|||lang||string||Default value is "en" (English). The language to be used by comment email templates.|
Response Object Data Members
|unsubscribeToken||string||A secured ticket that can be used to unsubscribe the user from the comments stream.|