---
title: "Patch connector"
method: PATCH
path: "/api/connectors/by-id/{id}"
---

# Patch connector

`PATCH /api/connectors/by-id/{id}`

## Request

- Base URL: `https://reduck.ai`
- URL: `https://reduck.ai/api/connectors/by-id/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Rename a connector, or remove its label.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `label` string, nullable: A name for the connector, to tell it apart from the site's other connectors.
  - `account` string: The account a probe reported. Only Reduck's own run service sets it.

## Response `200`

OK

- Connector
  - `id` string, required
  - `host` string, required: The website, bare: no scheme, no leading "www.", e.g. "linkedin.com". For an SSO connector this is the identity provider, e.g. "accounts.google.com".
  - `profile_id` string, required: The end-user this connector is kept for, as the developer named them. Empty for the account's own connectors.
  - `account` string, nullable, required: The identity a probe script or the SSO sign-in reported (usually an email). Null until one has; it is never set by hand.
  - `label` string, nullable, required: The name a person gave this connector, to tell it apart from the host's others.
  - `is_sso` boolean, required: True when this is an identity-provider session usable for "Continue with <provider>".
  - `sso_account` string, nullable, required: For a connector created through an SSO connector: that SSO's account (email). The reference autoreconnect follows. Null otherwise.
  - `created_at` string, required
  - `updated_at` string, required

## Other responses

- `400`: The request is malformed, or it sets an account: only a probe script records one.
- `401`: Not authenticated
- `403`: Forbidden
- `404`: Not found
- `409`: Another connector on the site already has that label for this profile.

---

[API](https://skmtc.dev/reduck/apis/reduck-api.md) · [All operations](https://skmtc.dev/reduck/apis/reduck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reduck/apis/reduck-api/revisions/a573b91206d6?raw)