---
title: "Create a Connect installation request"
method: POST
path: "/v1/connect/install/{connector}"
tags: ["connect"]
---

# Create a Connect installation request

`POST /v1/connect/install/{connector}`

Create an installation request for a connector and return the URL and verifier details needed to complete the flow.

## Path parameters

- `connector` string, required

## Request body

- object
  - `installationId` string
  - `audience` string[]
  - `scopes` string[]
  - `resources` string[]
  - `authorizationDetails` object[]
    - `type` string
  - `validityBufferMs` number
  - `returnUrl` string
  - `webhook` string
  - `tenantId` string
  - `deviceCode` boolean
  - `expiresInMs` number

## Response `200`

- object
  - `url` string, required
  - `request` string, required
  - `verifier` string, required
  - `deviceCode` string
  - `expiresAt` number, required
  - `connector` object, required
    - `id` string, required — Client id (e.g. `scl_…`).
    - `uid` string, required — Client uid (e.g. `salesforce/my-org`).
    - `type` string, required — Client type (e.g. `oauth`, `salesforce`).
    - `service` string — Resolved service id when known (e.g. `salesforce`), following the `stored.service ?? typeDef.service ?? stored.type` convention.
    - `serviceName` string — Curated display name of the resolved service (e.g. "Salesforce"), present when the service is a known service. Suited for end-user surfaces like "Sign in with {serviceName}".
    - `name` string, required — The connector's own name: the operator-given client name, falling back to the client type's name for legacy rows without one.

## Other responses

- `400` — One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
- `401` — The request is not authorized.
- `403` — You do not have permission to access this resource.
- `404`
- `410`
- `422`

---

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