Skip to main content
PATCH
Update Prompt

Authorizations

X-Lightsage-Api-Key
string
header
required

Path Parameters

prompt_id
string
required

Body

application/json
text
string
Minimum string length: 1
topic_id
string

Prompt topic ID from GET /v2/prompts/topics.

platform_ids
string[] | null

Replacement list of answer-platform IDs.

status
enum<string>
Available options:
active,
inactive
is_branded
boolean

Marks the prompt as branded or unbranded. Omit to keep the current value; changing text does not change it.

run_settings
V2PromptRunSettingsInput · object | null

Run settings that apply to coding-agent runs of this prompt. Omitted fields keep their current or default values.

Response

Successful Response

id
string
required
topic_id
string
required
text
string
required
status
enum<string>
required

The prompt lifecycle status. Only active prompts run on schedule.

Available options:
active,
inactive,
archived
is_branded
boolean
default:false

Whether the prompt text names your own brand. Detected when the prompt is created, and can be set explicitly.

language_id
string | null
region_id
string | null
topic
PublicPromptTopic · object | null
platforms
PublicPromptPlatform · object[]
tags
PublicPromptTag · object[]
created_at
string | null
updated_at
string | null
run_settings
V2PromptRunSettings · object

Run settings that apply to coding-agent runs of this prompt.