API ReferenceConnections

Connect

Creates a new request for [Polytomic Connect](https://www.polytomic.com/connect). This endpoint configures a Polytomic Connect request and returns the URL to redirect users to. This allows embedding Polytomic connection authorization in other applications. See also: - [Embedding authentication](https://apidocs.polytomic.com/2024-02-08/guides/embedding-authentication), a guide to using Polytomic Connect.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
namestringRequired
Name of the new connection. Must be unique per organization.
redirect_urlstringRequired
URL to redirect to after connection is created.
connectionstringOptionalformat: "uuid"
The id of an existing connection to update.
darkbooleanOptional
Whether to use the dark theme for the Connect modal.
organization_idstringOptionalformat: "uuid"
whitelistlist of stringsOptional
List of connection types which are allowed to be created. Ignored if type is set.
typestringOptionalDeprecated
Connection type to create.

Response

OK
dataobject or null

Errors