Rename, archive or restore a source

Requires current workspace membership. Manager-only operations include permission and project-link management. Text approval requires a separate language review grant; resource editor access never grants translation permissions. Expected versions and branch scope are checked before mutation. Source and context text are not telemetry.

PATCH /api/v1/workspaces/{workspaceId}/knowledge-resources/{resourceId}

Operation: updateKnowledgeResource · Download OpenAPI

Access

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
  "type": "apiKey",
  "in": "cookie",
  "name": "localisync_session"
}

Parameters

Name	Location	Required	Description
workspaceId	path	Yes	See constraints below.
resourceId	path	Yes	See constraints below.
Origin	header	Yes	See constraints below.
X-CSRF-Token	header	Yes	See constraints below.

workspaceId

{
  "type": "string",
  "format": "uuid"
}

resourceId

{
  "type": "string",
  "format": "uuid"
}

Origin

{
  "type": "string",
  "format": "uri"
}

X-CSRF-Token

{
  "type": "string"
}

Request body

Required: Yes.

application/json

Schema reference: ResourceUpdate.

Field	Type	Required	Constraints / description
version	integer	Yes	maximum: 2147483646
name	string	Yes	minLength: 1; maxLength: 100
archived	boolean	Yes	—

{
  "$ref": "#/components/schemas/ResourceUpdate"
}

Responses

200

Result returned.

Content type: application/json Schema reference: Resource.

Field	Type	Required	Constraints / description
name	string	Yes	minLength: 1; maxLength: 100
kind	glossary, memory	Yes	—
id	string	Yes	format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
version	integer	Yes	maximum: 2147483646
editable	boolean	Yes	—
archivedAt	See schema	Yes	—

{
  "$ref": "#/components/schemas/Resource"
}

400

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

401

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

403

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

404

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

409

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

413

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

429

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

500

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

503

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	Yes	—
details	See schema	No	—

{
  "$ref": "#/components/schemas/Error"
}

Related guidance

Request errors and safe retries · Troubleshooting