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.

Authentication

AuthorizationBearer

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

Headers

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

Errors

401
Connections Connect Request Unauthorized Error
403
Connections Connect Request Forbidden Error
422
Connections Connect Request Unprocessable Entity Error
500
Connections Connect Request Internal Server Error