v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB

Prompts

Update Prompt

Update a prompt with new content or properties. Your production prompt stays safe—updates create new versions without affecting what's currently active.

How it Works:

Updating components: Creates a new immutable version with fingerprinting. The new version is created but NOT activated, so you can test before going live.
Updating only properties (name/description): Updates the prompt in-place without creating a new version.

Version Safety: Old versions always point to their original prompts, preserving your message history and allowing you to roll back if needed.

put/prompts/{id}

Path parameters

idstring uuid required

The prompt ID to update

Request body

namestring

Updated prompt name.

descriptionstring

Updated prompt description.

rolestring

Role key in the product mapping.

source'customer' | 'participant' | 'greenflash' | 'agent'

Prompt source.

Response

Prompt updated successfully

externalPromptIdstring

The external prompt ID.

promptIdstring uuid required

The updated prompt ID.

versionIdstring uuid nullable required

The version ID. Version is created/updated but not activated (activation happens via UI). Null if only prompt metadata was updated without components.