---
title: "Partial update connector"
method: PATCH
path: "/api/v1/connectors/{connectorID}"
tags: ["Connector"]
---

# Partial update connector

`PATCH /api/v1/connectors/{connectorID}`

Update part of connector object.

## Path parameters

- `connectorID` integer, required

## Request body

- ConnectorBase
  - `id` integer — ID of the connector
  - `name` string — Name of the connector (not visible in UI)
  - `url` string, uri — URL of the connector
  - `queues` string[] — List of queues that use connector object
  - `service_url` string, uri — URL of the connector endpoint
  - `params` string, nullable — Query params appended to the service_url
  - `client_ssl_certificate` string, nullable — Client SSL certificate used to authenticate requests. Must be PEM encoded.
  - `client_ssl_key` string, nullable — Client SSL key (write only). Must be PEM encoded. Key may not be encrypted.
  - `authorization_type` 'secret_key' | 'Basic' — String sent in HTTP header `Authorization` could be set to `secret_key` or `Basic`. For details see [Connector API](/guides/extensions#connector-extension).
  - `authorization_token` string — Token sent to connector in `Authorization` header to ensure connector was contacted by Rossum (displayed only to `admin` user).
  - `asynchronous` boolean — Affects exporting: when `true`, [confirm](/api/annotation#confirm-validation) endpoint returns immediately and connector's `save` endpoint is called asynchronously later on.
  - `metadata` Metadata — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
  - `modified_by` string, uri, nullable — User that last modified the object.
  - `modified_at` string, date-time, nullable — Timestamp of last modification.

## Response `200`

OK

- Connector
  - `id` integer, required — ID of the connector
  - `name` string, required — Name of the connector (not visible in UI)
  - `url` string, uri, required — URL of the connector
  - `queues` string[], required — List of queues that use connector object
  - `service_url` string, uri, required — URL of the connector endpoint
  - `params` string, nullable, required — Query params appended to the service_url
  - `client_ssl_certificate` string, nullable, required — Client SSL certificate used to authenticate requests. Must be PEM encoded.
  - `client_ssl_key` string, nullable, required — Client SSL key (write only). Must be PEM encoded. Key may not be encrypted.
  - `authorization_type` 'secret_key' | 'Basic', required — String sent in HTTP header `Authorization` could be set to `secret_key` or `Basic`. For details see [Connector API](/guides/extensions#connector-extension).
  - `authorization_token` string, required — Token sent to connector in `Authorization` header to ensure connector was contacted by Rossum (displayed only to `admin` user).
  - `asynchronous` boolean, required — Affects exporting: when `true`, [confirm](/api/annotation#confirm-validation) endpoint returns immediately and connector's `save` endpoint is called asynchronously later on.
  - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
  - `modified_by` string, uri, nullable, required — User that last modified the object.
  - `modified_at` string, date-time, nullable, required — Timestamp of last modification.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `413` — Payload too large (especially for files uploaded).
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)