Update a connector category. PATCH /api/openapi/v1/connector-categories/{categoryId}, scope admin.v1.connectors.manage.
- Scope: admin.v1.connectors.manage
- Permission: Manage connectors (connectors)
- Permission type: Manage
- Endpoint: PATCH/api/openapi/v1/connector-categories/{categoryId}
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.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| categoryId | path | string · uuid | Required | Category ID | "<uuid>" |
| expected_revision | body | integer · int64 | Required | Revision returned by the latest category read; the update is rejected when the category changed concurrently. | 1 |
| name | body | string | No | Category name | "<string>" |
| order | body | integer · int64 | No | Sort order | 0 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| category_id | string · uuid | Yes | Category (category ID) | "<uuid>" |
| name | string | Yes | Category name | "<string>" |
| order | integer · int64 | Yes | Sort order | 0 |
| revision | integer · int64 | Yes | Optimistic-lock revision to pass as expected_revision on the next update. | 1 |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |