/sharing/direct

This API shares activity information directly with the specified recipients on a provider's network, instead of publishing it to everyone on the network.

The direct call shares with one provider at a time, determined by the identifier or device_token you enter.

Note. Not all providers support all sharing parameters. To see which providers support what features, refer to the Sharing Support by Provider page.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint uses your social login API key for authentication. This key can be found on the Settings page of the Social Login Dashboard.

Base URL

The base URL for this endpoint is your application domain followed by /api/v2; for example:

https://educationcenter.rpxnow.com/api/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

Example Request

This command shares activity information with the user who has the social login identifier http://www.linkedin.com/profile?viewProfile=V8aqgNeblH.


curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  --data-urlencode identifier=0987098709870987 \
  --data-urlencode recipients='["http://www.linkedin.com/profile?viewProfile=V8aqgNeblH"]' \
  --data-urlencode message='Testing one two three' \
  --data-urlencode title='My title' \
  --data-urlencode url=http://rpxme.com/test \
  https://janrain-docs.rpxnow.com/api/v2/sharing/direct
                
      Running this command in Postman

Example Response


{
  "stat": "ok",
  "response": {
    "provider": "twitter",
    "mode": "direct",
    "success": true,
    "recipientIds": [
      "123456789"
    ],
    "results": [
      {
        "success": true,
        "recipientId": "123456789",
        "share": {
          "message": "Testing one two three."
        },
        "messageId": "123456789123456789"
      }
    ]
  }
}
                

Query Parameters

Parameter Type Required Description
actionLink string Link that appears below the user-generated message and content fields.
 
apiKey string Yes Social Login API key. This key can be found on the Social Login Dashboard.
 
description string Description of the shared content. The description appears in the preview of the shared object and explains what is being shared.
 
device_token string Identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
 
identifier string Identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
image string Image associated with the content being shared.
 
media string Flash or video object associated with the content being shared.
 
message string Message associated with the activity being shared.
 
recipients string Yes JSON-formatted list of identifiers associated with the recipients being contacted.
 
recipientUrls string Enables sharing multiple URLs to multiple recipients. The parameter value must be a JSON object of recipients and shared URLs. For example:
 
{"http://myidentifier.com": "http://janrain.com"}
Recipients not appearing in this object use the value defined in the URL parameter to share.
 
shortenURL string When set to false, disables the URL shortening service. When true, activates URL shortening.
 
source string URL of the site sharing the activity.
 
title string Title given to the shared content.
 
url string URL associated with the content being shared.