---
title: "Update a Connector"
method: PATCH
path: "/v1/connectors/{id}"
tags: ["/connectors"]
deprecated: true
---

# Update a Connector

`PATCH /v1/connectors/{id}`

> **Deprecated.**

Update a connector by ID. Omitted fields will not be updated. See ['Managing your Connector'](https://docs.cohere.com/docs/managing-your-connector) for more information.

## Path parameters

- `id` string, required

## Headers

- `X-Client-Name` string

## Request body

- UpdateConnectorRequest
  - `name` string — A human-readable name for the connector.
  - `url` string — The URL of the connector that will be used to search for documents.
  - `excludes` string[] — A list of fields to exclude from the prompt (fields remain in the document).
  - `oauth` CreateConnectorOAuth
    - `client_id` string — The OAuth 2.0 client ID. This fields is encrypted at rest.
    - `client_secret` string — The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response.
    - `authorize_url` string — The OAuth 2.0 /authorize endpoint to use when users authorize the connector.
    - `token_url` string — The OAuth 2.0 /token endpoint to use when users authorize the connector.
    - `scope` string — The OAuth scopes to request when users authorize the connector.
  - `active` boolean
  - `continue_on_failure` boolean
  - `service_auth` CreateConnectorServiceAuth
    - `type` 'bearer' | 'basic' | 'noscheme', required — The token_type specifies the way the token is passed in the Authorization header. Valid values are "bearer", "basic", and "noscheme".
    - `token` string, required — The token that will be used in the HTTP Authorization header when making requests to the connector. This field is encrypted at rest and never returned in a response.

## Response `200`

OK

- UpdateConnectorResponse
  - `connector` Connector, required — A connector allows you to integrate data sources with the '/chat' endpoint to create grounded generations with citations to the data source. documents to help answer users.
    - `id` string, required — The unique identifier of the connector (used in both `/connectors` & `/chat` endpoints). This is automatically created from the name of the connector upon registration.
    - `organization_id` string — The organization to which this connector belongs. This is automatically set to the organization of the user who created the connector.
    - `name` string, required — A human-readable name for the connector.
    - `description` string — A description of the connector.
    - `url` string — The URL of the connector that will be used to search for documents.
    - `created_at` string, date-time, required — The UTC time at which the connector was created.
    - `updated_at` string, date-time, required — The UTC time at which the connector was last updated.
    - `excludes` string[] — A list of fields to exclude from the prompt (fields remain in the document).
    - `auth_type` string, enum — The type of authentication/authorization used by the connector. Possible values: [oauth, service_auth]
    - `oauth` ConnectorOAuth
      - `client_id` string — The OAuth 2.0 client ID. This field is encrypted at rest.
      - `client_secret` string — The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response.
      - `authorize_url` string, required — The OAuth 2.0 /authorize endpoint to use when users authorize the connector.
      - `token_url` string, required — The OAuth 2.0 /token endpoint to use when users authorize the connector.
      - `scope` string — The OAuth scopes to request when users authorize the connector.
    - `auth_status` 'valid' | 'expired' — The OAuth status for the user making the request. One of ["valid", "expired", ""]. Empty string (field is omitted) means the user has not authorized the connector yet.
    - `active` boolean — Whether the connector is active or not.
    - `continue_on_failure` boolean — Whether a chat request should continue or not if the request to this connector fails.

## Other responses

- `400` — This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields
- `401` — This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions
- `403` — This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions
- `404` — This error is returned when a resource is not found. This could be because: - The endpoint does not exist - The resource does not exist eg model id, dataset id
- `422` — This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields
- `429` — Too many requests
- `498` — This error is returned when a request or response contains a deny-listed token.
- `499` — This error is returned when a request is cancelled by the user.
- `500` — This error is returned when an uncategorised internal server error occurs.
- `501` — This error is returned when the requested feature is not implemented.
- `503` — This error is returned when the service is unavailable. This could be due to: - Too many users trying to access the service at the same time
- `504` — This error is returned when a request to the server times out. This could be due to: - An internal services taking too long to respond

---

[API](https://skmtc.net/cohere-ai/apis/api-reference.md) · [All operations](https://skmtc.net/cohere-ai/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cohere-ai/api-reference/revisions/dbed69eda210/schema)