Update KnowledgeFeature

Updates an existing KnowledgeFeature. Knowledge features represent specific data points within knowledge items.

PUT /api/knowledge-features/{id}

Update KnowledgeFeature

cURL

curl --request PUT \
  --url https://platform.kodexa.ai/api/knowledge-features/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": true,
  "changeSequence": 123,
  "extendedProperties": null,
  "featureType": {
    "active": true,
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "extendedOptions": null,
    "icon": "<string>",
    "id": "<string>",
    "labelJsonPath": "<string>",
    "name": "<string>",
    "options": null,
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "useJSONata": true,
    "uuid": "<string>",
    "orgSlug": "<string>"
  },
  "featureTypeId": "<string>",
  "featureTypeRef": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "properties": null,
  "slug": "<string>"
}
'

200

{
  "active": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "extendedProperties": null,
  "featureType": {
    "active": true,
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "extendedOptions": null,
    "icon": "<string>",
    "id": "<string>",
    "labelJsonPath": "<string>",
    "name": "<string>",
    "options": null,
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "useJSONata": true,
    "uuid": "<string>",
    "orgSlug": "<string>"
  },
  "featureTypeId": "<string>",
  "id": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "organizationId": "<string>",
  "properties": null,
  "slug": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "featureTypeRef": "<string>",
  "orgSlug": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Body

application/json

A knowledge feature represents a specific data point within a knowledge item.

active · boolean

changeSequence · integer<int32>

extendedProperties · unknown

featureType · object | null

A knowledge feature type defines the kind of data a knowledge feature can hold.

Show child attributes

featureTypeId · string | null

featureTypeRef · string

orgSlug · string

organization · object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

properties · unknown

slug · string

Response

200

application/json

Updated KnowledgeFeature

A knowledge feature represents a specific data point within a knowledge item.

active · boolean · required

changeSequence · integer<int32> · required

createdOn · string<date-time> · required

extendedProperties · unknown · required

featureType · object | null · required

A knowledge feature type defines the kind of data a knowledge feature can hold.

Show child attributes

featureTypeId · string | null · required

id · string · required

organization · object | null · required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

organizationId · string | null · required

properties · unknown · required

slug · string · required

updatedOn · string<date-time> · required

uuid · string · required

featureTypeRef · string

orgSlug · string