Skip to main content
PUT
Update Prompts

Authorizations

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

Prompt metadata defines a prompt template used by AI assistants for document processing.

changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the prompt was created.

deleteUserEmail
string | null
deleteUserId
string | null
deleted
boolean
deletedDate
string<date-time> | null
deprecated
boolean

Whether this prompt is deprecated.

extensionPackRef
string
id
string

Unique identifier (UUID) for the prompt.

metadata
string<byte>
name
string

Display name of the prompt.

organizationId
string
publicAccess
boolean

Whether the prompt is publicly accessible.

slug
string

URL-friendly identifier for the prompt.

template
boolean

Whether this prompt is a template.

type
string
updatedOn
string<date-time>

Timestamp when the prompt was last updated.

uuid
string

Secondary UUID identifier.

yamlSource
string | null

Response

Updated Prompts

Prompt metadata defines a prompt template used by AI assistants for document processing.

changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the prompt was created.

deleteUserEmail
string | null
deleteUserId
string | null
deleted
boolean
deletedDate
string<date-time> | null
deprecated
boolean

Whether this prompt is deprecated.

extensionPackRef
string
id
string

Unique identifier (UUID) for the prompt.

metadata
string<byte>
name
string

Display name of the prompt.

organizationId
string
publicAccess
boolean

Whether the prompt is publicly accessible.

slug
string

URL-friendly identifier for the prompt.

template
boolean

Whether this prompt is a template.

type
string
updatedOn
string<date-time>

Timestamp when the prompt was last updated.

uuid
string

Secondary UUID identifier.

yamlSource
string | null