---
title: "Connect"
method: POST
path: "/api/connections/connect/"
tags: ["Connections"]
---

# Connect

`POST /api/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](../../../guides/embedding-authentication), a guide to using Polytomic Connect.

## Headers

- `X-Polytomic-Version` string

## Request body

- ConnectCardRequest
  - `connection` string, uuid — The id of an existing connection to update.
  - `dark` boolean — Whether to use the dark theme for the Connect modal.
  - `name` string, required — Name of the new connection. Must be unique per organization.
  - `organization_id` string, uuid, nullable
  - `redirect_url` string, required — URL to redirect to after connection is created.
  - `ttl` integer, nullable — Connect session lifetime in seconds. Defaults to 300 and cannot exceed 604800.
  - `type` string — Connection type to create.
  - `use_organization_name` boolean — 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.
  - `whitelist` string[], nullable — List of connection types which are allowed to be created. Ignored if type is set.

## Response `200`

OK

- ConnectCardResponseEnvelope
  - `data` ConnectCardResponse
    - `redirect_url` string — URL that opens the Polytomic Connect flow for creating or reconnecting a Connection.
    - `token` string — Token for the Polytomic Connect session.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/b509e00e80aa/schema)