USusesapient
Prompts

Update Prompt

Changed on

Updates a prompt's text, topic, platforms, or lifecycle status. Omitted fields remain unchanged.

patch/v1/prompts/{prompt_id}

Request

  • Base URL
    https://api.lightsage.com
  • Auth
    API key in header X-Lightsage-Api-Key

Path parameters

prompt_idstring required

Request body

textstring
topic_idstring

Topic ID from GET /v1/prompts/config.

platform_idsstring[] nullable

Replaces the platform list. IDs from GET /v1/prompts/config.

status'active' | 'inactive'
is_brandedboolean

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

Response

Successful Response

idstring required
topic_idstring required
textstring required
is_brandedboolean

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

language_idstring nullable
region_idstring nullable
status'active' | 'inactive' | 'archived' required

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

created_atstring nullable
updated_atstring nullable

Changes