Gigya Job Openings

comments.unsubscribe JS

Skip to end of metadata
Go to start of metadata



Allows a user to unsubscribe from a comments stream.


Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

REST API > comments.unsubscribe.




The following table lists the available parameters:

categoryIDstringThe identifier of the comment category to which the user subscribes. This parameter together with streamID is required if unsubscribeToken is not provided.
streamIDstringThe identifier of the comment stream to which the user subscribes. This parameter together with categoryID is required if unsubscribeToken is not provided.
unsubscribeTokenstringThe secure ticket that was returned in comments.subscribe. This parameter is required if categoryID and streamID aren't provided.


Response Object Data Members

errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.


Code Sample

var params = {
  categoryID: "789",  
    streamID: "abc"



  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider ? prior to calling the API method. You can learn more in the Social Login guide.