Skip to main content
PUT
Update prompt

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

prompt_id
string
required

Prompt identifier

Query Parameters

source_target_kind
string

Where to write the prompt file: project (the default) or preview_branch. Other values are rejected.

target_branch_id
string<uuid> | null

Preview branch to use. Required for the preview_branch target; rejected for any other target.

Body

application/json
content
string
required

Prompt text.

Minimum string length: 1
description
string | null

Prompt description. Null clears it. When omitted, REST and GraphQL clear it and the MCP tool keeps the current one.

Response

Updated prompt document

id
string
required
name
string
required
description
string | null
required
content
string | null
required
source_path
string
required
source
string
required
edit_mode
enum<string>
required
Available options:
structured,
source_only
source_only_reasons
string[]
required