The set_backplane_properties call configures the Backplane server used to communicate with all of the Backplane-enabled apps on a page. 

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 Backplane server properties for the social login application 1234567891234567891234567891234567891234.

curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  --data-urlencode server=example.com \
  --data-urlencode bus=example_bus \
  --data-urlencode username=larrydrebes \
  --data-urlencode password=rosebud \
      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.
bus string Yes Backplane bus name.
password string Password portion of the Backplane credentials. This parameter is required if you do not include the remove parameter.
remove string When set to true, removes the Backplane configuration for the specified server or bus. When false, creates a new Backplane configuration.
server string Yes Domain name for the Backplane server. For example:

username string Username portion of the Backplane credentials. This parameter is required if you do not include the remove parameter.
version string Backplane server version. The default value is v1.