Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Connector

Partial update connector

Changed on Sep 1, 2026

Update part of connector object.

patch/api/v1/connectors/{connectorID}

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/connectors/:connectorID/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connectorIDinteger required

A unique integer value identifying this connector.

Request body

idinteger

ID of the connector

namestring

Name of the connector (not visible in UI)

urlstring uri

URL of the connector

queuesstring[]

List of queues that use connector object

service_urlstring uri

URL of the connector endpoint

paramsstring nullable

Query params appended to the service_url

client_ssl_certificatestring nullable

Client SSL certificate used to authenticate requests. Must be PEM encoded.

client_ssl_keystring 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.

authorization_tokenstring

Token sent to connector in Authorization header to ensure connector was contacted by Rossum (displayed only to admin user).

asynchronousboolean

Affects exporting: when true, confirm endpoint returns immediately and connector's save endpoint is called asynchronously later on.

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 1500,
  "name": "MyQ Connector",
  "url": "https://example.rossum.app/api/v1/connectors/1500",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "service_url": "https://myq.east-west-trading.com",
  "params": "strict=true",
  "client_ssl_certificate": "-----BEGIN CERTIFICATE-----\n...",
  "authorization_type": "secret_key",
  "authorization_token": "wuNg0OenyaeK4eenOovi7aiF",
  "asynchronous": true,
  "metadata": {
    "some_key": "some_value"
  },
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

idinteger required

ID of the connector

namestring required

Name of the connector (not visible in UI)

urlstring uri required

URL of the connector

queuesstring[] required

List of queues that use connector object

service_urlstring uri required

URL of the connector endpoint

paramsstring nullable required

Query params appended to the service_url

client_ssl_certificatestring nullable required

Client SSL certificate used to authenticate requests. Must be PEM encoded.

client_ssl_keystring 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.

authorization_tokenstring required

Token sent to connector in Authorization header to ensure connector was contacted by Rossum (displayed only to admin user).

asynchronousboolean required

Affects exporting: when true, confirm endpoint returns immediately and connector's save endpoint is called asynchronously later on.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 1500,
  "name": "MyQ Connector",
  "url": "https://example.rossum.app/api/v1/connectors/1500",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "service_url": "https://myq.east-west-trading.com",
  "params": "strict=true",
  "client_ssl_certificate": "-----BEGIN CERTIFICATE-----\n...",
  "authorization_type": "secret_key",
  "authorization_token": "wuNg0OenyaeK4eenOovi7aiF",
  "asynchronous": true,
  "metadata": {
    "some_key": "some_value"
  },
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

Sep 1, 2026f1b5a910991d Revision changes
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added subschema #2 to the response body allOf list for the response status
- info
  removed the optional write-only property client_ssl_key from the response with the status

Operation history