Use set_share_providers to define the providers offered by Social Sharing. You can set both sharing and email providers.

Note. This call overwrites the existing providers, if any.

In addition to the providers listed in the share parameter, you can enter email as well. This signifies direct sharing through email.

Accepted Content-types

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

This endpoint includes the following methods:

  • POST



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:


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

Example Request

This command configures email and linkedin as sharing providers for the social login application 1234567891234567891234567891234567891234.

curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  --data-urlencode share='email, linkedin' \
      Running this command in Postman

Example Response

  "stat": "ok"

Query Parameters

Parameter Type Required Description
apiKey string Yes Social Login API key. This key can be found on the Social Login Dashboard.
email string Email provider options. If no values are supplied the UI will not have any email provider options.​
share string Yes Sharing provider options. If no values are supplied the UI will not have any sharing provider options.
format string The format to use in the response, either json, or xml. The default is json.
share string Yes Sharing providers to add as choices. This may be left empty, in which case the UI will have no sharing provider options.