Skip to main content

Update a connector

Update a connector. PATCH /api/openapi/v1/connectors/{resourceId}, scope admin.v1.connectors.manage.

  • Scope: admin.v1.connectors.manage
  • Permission: Manage connectors (connectors)
  • Permission type: Manage
  • Endpoint: PATCH/api/openapi/v1/connectors/{resourceId}

Authentication and request headers

Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

NameLocationTypeRequiredDescriptionExample
resourceIdpathstring · uuidRequiredResource ID"<uuid>"
category_idbodystringNoCategory (category ID)"<string>"
clear_categorybodybooleanNoClear categoryfalse
clientsbodyarray | nullNoSupported clients["<string>"]
descriptionbodystringNoDescription (English)"<string>"
description_cnbodystringNoDescription"<string>"
display_namebodystringNoConnector name (English)"<string>"
display_name_cnbodystringNoConnector name"<string>"
expected_market_item_revisionbodyinteger · int64NoExpected market item revision for concurrent update checks0
expected_revisionbodyinteger · int64NoExpected revision for concurrent update checks0
icon_upload_idbodystringNoResource icon (upload session ID)"<string>"
icon_urlbodystringNoResource icon (URL)"<string>"
statusbodystringNoEnabled"<string>"

Request example

cURL

Responses

200 OK
NameTypeRequiredDescriptionExample
api_keyOpenapifacadeConnectorAPIKeyConfigNoAPI Key configuration{"header_name":"<string>","value_prefix":"<string>"}
api_key.header_namestringYesHeader name"<string>"
api_key.value_prefixstringNoValue prefix"<string>"
auth_typestringYesAuthorization method"<string>"
clientsarray | nullYesSupported clients["<string>"]
commandstringNoStartup command"<string>"
created_atstring · date-timeYesCreated at"2026-08-27T10:00:00Z"
descriptionstringNoDescription (English)"<string>"
description_cnstringNoDescription"<string>"
display_namestringNoConnector name (English)"<string>"
display_name_cnstringNoConnector name"<string>"
icon_urlstringNoResource icon (URL)"<string>"
idstringYesConnector ID"<string>"
oauth_client_registrationstringNoOAuth client registration configuration"<string>"
oauth_scopesstringNoOAuth Scopes"<string>"
originstringYesOrigin"<string>"
revisioninteger · int64YesRevision used for concurrent update checks0
server_keystringYesUnique identifier"<string>"
source_typestringNoSource type"official"
statusstringYesEnabled"<string>"
transportstringYesTransport protocol"<string>"
updated_atstring · date-timeYesUpdated at"2026-08-27T10:00:00Z"
urlstringNoService URL"<string>"
versionstringNoVersion"<string>"
Response example
default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example