Gigya Job Openings

comments.setStreamInfo REST

Skip to end of metadata
Go to start of metadata


Sets information of a specified commenting stream, for the usage of RSS.


Request URL

Where <Data_Center> is:
  • - For the US data center.
  • - For the European data center.
  • - For the Australian data center.
  • - For the Russian data center.
  • - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.


categoryIDstringThe identifier of the comments category to which the stream of discussion belongs.
streamIDstringThe unique ID of the stream to which you would like to set information. Note: the string is limited to 150 characters and is case-sensitive.
streamTitlestringThe title assigned to the commenting stream. This title you assign here will be assigned to each comment posted to be used for RSS & HTML outputs.
streamURLstringThe stream URL assigned to the commenting stream (usually the URL of the page where the commenting stream is presented). This URL you assign will be assigned to each comment posted to be used for RSS & HTML outputs. This URL will link back from the RSS or HTML page to the original post where the comment was added.
Note: Gigya will verify that the streamURL belongs to your site (as configured for your API key in the Dashboard section on Gigya's website).
streamInfoSigstringThis field is not required the first time this method is called, when the streamTitle and streamURL fields in Gigya's DB are empty. Gigya requires this call to be signed, when overriding existing values. Calculate the signature (SHA1 signature) in the same manner as described under Generating the Signature section, using the following base string “categoryID_streamID_streamTitle_streamURL”.

If streamTags or modeationModes are set, you must include them in this signature as well.

Either a comma separated list or an array of tags (strings) that should be associated with the stream. The tags you assign here will be assigned to the stream, to be used to filter the top streams in comments.getTopStreams.

An object containing string values that specify the moderation mode for different comments according to their content type (see Moderation Modes for more information).

    "text": "post|pre|guest|inherit",
    "image": "post|pre|guest|inherit",
    "video": "post|pre|guest|inherit",
    "url": "post|pre|guest|inherit",
    "other": "post|pre|guest|inherit"

When using this field, it is not necessary to set the moderation mode for all content types. Content types that are not referred to will retain their previous moderation state. The default state for each content type is "inherit" (the stream will use the category moderation mode settings). 

modestringThe value accepted for the mode are:
  • enabled - the stream is enabled (default).
  • disabled - the stream is disabled.
  • readOnly - the stream is in read only mode.

The mode can be changed only by a secured request.

format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.
 moderationModestringDeprecated. Use moderationModes instead.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

Sample Requests


Response Data

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 Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.



Response Example

        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "31ba039fb8d340ceb2f43d52c89bf187",