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}

cURL

curl --request PUT \
  --url https://www.greenflash.ai/api/v1/prompts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Customer Support Prompt",
  "description": "Updated description",
  "components": [
    {
      "content": "You are a helpful assistant for {{productName}}. Always be polite to {{userName}}.",
      "type": "system",
      "source": "customer",
      "name": "Base Instructions V2"
    }
  ]
}
'

{
  "promptId": "123e4567-e89b-12d3-a456-426614174004",
  "versionId": "123e4567-e89b-12d3-a456-426614174005"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

The prompt ID to update

Body

application/json

name

string

Updated prompt name.

description

string

Updated prompt description.

role

string

Role key in the product mapping.

source

enum<string>

default:customer

Prompt source.

Available options:

customer,

participant,

greenflash,

agent

components

object[]

Updated components (if provided, creates new immutable prompt and version).

Show child attributes

Response

Prompt updated successfully

promptId

string<uuid>

required

The updated prompt ID.

versionId

string<uuid> | null

required

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

externalPromptId

string

The external prompt ID.

Archive PromptArchive a prompt you no longer need. Archived prompts are soft-deleted (we set an `archived_at` timestamp) so you can still access them for historical data. **Safety First:** - Can't archive a prompt that's currently active. You must activate a different version first. - Historical data is preserved—old conversations continue to reference archived prompts so your message history stays intact. - Archived prompts remain accessible for reporting and analysis.

cURL

curl --request PUT \
  --url https://www.greenflash.ai/api/v1/prompts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Customer Support Prompt",
  "description": "Updated description",
  "components": [
    {
      "content": "You are a helpful assistant for {{productName}}. Always be polite to {{userName}}.",
      "type": "system",
      "source": "customer",
      "name": "Base Instructions V2"
    }
  ]
}
'

{
  "promptId": "123e4567-e89b-12d3-a456-426614174004",
  "versionId": "123e4567-e89b-12d3-a456-426614174005"
}