Skip to main content
POST
Publish template version

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

templateId
string<uuid>
required

Template ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json

Body

Publish a complete immutable template snapshot. Omitted components inherit from the preceding version; null explicitly clears a component.

prompt
string | null

Prompt; omit to inherit, null to clear

schemaId
string<uuid> | null

Schema ID; omit to inherit, null to clear (mutually exclusive with schemaFields)

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
schemaFields
object[] | null

Inline schema fields; omit to inherit, null to clear

schemaEntity
string

Entity name for supplied inline schema fields

schemaValidationRules
object | null

Rules; omit to inherit rules for fields retained by a replacement schema, null to clear, {} to manage an empty ruleset

notifications
object[] | null

Notifications; omit to inherit, null or [] to clear

frequency
object | null

Frequency; omit to inherit, null to clear

recordLimit
integer | null

Output record limit; omit to inherit, null for template-managed unlimited

Required range: 1 <= x <= 2147483647
recordLimitManaged
enum<boolean>

False clears template ownership of the output record limit

Available options:
false

Response

Response for template version create/update

Response for template version create/update

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
success
enum<boolean>
required

Success flag

Available options:
true
data
TemplateVersionResponse · object
required

Template version