Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Connections

Connect

Creates a Polytomic Connect session and returns a URL for creating or reconnecting a Connection.

Open the returned URL, or send it to the person who will set up the Connection. Polytomic Connect guides them through authentication and configuration, then redirects them to redirect_url.

Each session can create or reconnect one Connection.

See also:

  • Embedding authentication, a guide to using Polytomic Connect.
post/api/connections/connect/

Headers

X-Polytomic-Versionstring

Request body

connectionstring uuid

The id of an existing connection to update.

darkboolean

Whether to use the dark theme for the Connect modal.

namestring required

Name of the new connection. Must be unique per organization.

organization_idstring uuid nullable
redirect_urlstring required

URL to redirect to after connection is created.

ttlinteger nullable

Connect session lifetime in seconds. Defaults to 300 and cannot exceed 604800.

typestring

Connection type to create.

use_organization_nameboolean

Whether to display the target organization name instead of the partner name in the Connect modal. Defaults to false; organizations without a partner always display their organization name.

whiteliststring[] nullable

List of connection types which are allowed to be created. Ignored if type is set.

Example request

{
  "connection": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "name": "Salesforce Connection",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "ttl": 300,
  "type": "salesforce"
}

Response

OK

Example response

{
  "data": {
    "redirect_url": "https://app.polytomic.com/polytomic-connect?token=token",
    "token": "token"
  }
}