Last modified 11:47, 15 Sep 2014


Sends a notification to a list of friends. Note: To send a notification to a Twitter friend, the friend must be following you and you must also be following the friend.

Supporting Providers

The following providers currently support this operation: Twitter, LinkedIn, and Yahoo.



Request URL


Where <Data_Center_ID> is:

  • us1 - for the US datacenter
  • eu1 - for the European datacenter
  • au1 - for the Australian datacenter



Required Name Type Description
Required* UID string The unique ID of the user with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. See User.UID for more information.

Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.

Required recipients string A comma separated list of UIDs representing recipients that will receive this notification.
  body string The content of the notification.
Notification body should not include HTML tags. Links should be provided as simple urls, not <a> tags.
For Example:
body: 'Check out this lovely site:'
Each social network uses a different format for links. Gigya will identify your links and convert them to the proper format corresponding to the social network.
  subject string The subject of the notification.
Optional actionAttributes JSON object In Gamification your users receive points for actions they perform on your site, in this case sending a notification grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user sends a notification, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. 
actionAttributes contain a JSON object comprised of a series of attribute keys (categories) with associated values. You can also use a generic "tags" key. No more than three values can be given, they can be with a single key or each have their own key. For more information see Variants and Action Attributes. Action attributes are later used to filter GM Plugins by a certain attribute.
Example:  {"<attribute key1>": ["<attribute value1>", "<attribute value2>"],  "<attribute key2>": "<attribute value3>" }
  cid string A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
  context object A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
  shortURLs string

Using this parameter you may determine whether to use Gigya's URL shortening service for URLs passed in the status parameter. The optional values for this parameter are:

  • 'always' (default): always try to shorten URLs. Where providers permit, URLs are shortened based on the Data Center you are using. for US DC.  for users of the European data center. for Australian DC.
  • 'whenRequired': URLs longer than 139 characters are shortened in accordance with provider preferences.
  • 'never' - never shorten URLs. Where providers permit, URLs are left untouched.

URL shortening requirements vary between providers and depend on the particular type of action and its content. URL shortening is available for the following providers:

Provider Note
LinkedIn Shortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., is abbreviated to
Messenger Not for share
Delicious Shortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., is abbreviated to
WhatsApp Only on mobile
Google Bookmarks  
Pinterest Shortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., is abbreviated to

When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reportswill be available to you.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.
  format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
  callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
  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 occurs.


Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 


Response Data


Field Type Description
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.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format. i.e
Field Type Description

Note: A field that does not contain data will not appear in the response.


Response Example

    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "3353d2fbac894289977c102298df60d1"


Page statistics
608 view(s) and 1 edit(s)
Social share
Share this page?


This page has no custom tags.
This page has no classifications.


You must to post a comment.