Skip to main content
PATCH
Update prompts

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained until key deletion. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

resource_id
integer
required

Body

application/json
title
string
Maximum string length: 255
description
string

Brief description of what this prompt does

Maximum string length: 100000
prompt_type
string
Maximum string length: 50
enrich_type
string | null
Maximum string length: 100
prompt_text
string
Maximum string length: 100000
tone_of_voice
string | null
Maximum string length: 50
custom_tone
string | null
Maximum string length: 255
purpose
string | null
Maximum string length: 50
industry
string | null
Maximum string length: 50
point_of_view
string | null
Maximum string length: 50
include_spec_table
boolean
title_max_length
integer

Max character length for generated titles (titles enrichment only).

title_variants
integer

How many distinct title variants to generate per product (titles enrichment only).

title_include_brand
boolean

Include the brand name in generated titles when known (titles enrichment only).

target_size
string

Length preset for description / short_description enrichment.

Maximum string length: 20
target_word_count
integer | null

Explicit word target, used when target_size is 'custom'.

faq_types
string[]

FAQ type keys (products/services/faq_types.py); empty uses the industry defaults.

faq_max_questions
integer | null

Maximum FAQ items per product, 1 to 20 (faq enrichment only).

faq_use_web_research
boolean | null

Ground FAQ answers in the latest web research (faq enrichment only).

target_attribute_codes
string[]

Attribute codes a product_attributes prompt fills; empty fills every AI-enrichable attribute.

share_with_project
boolean

When true, other members of the prompt's project can see and use this prompt.

Response

OK

title
string
required
Maximum string length: 255
description
string
required

Brief description of what this prompt does

prompt_type
string
required
Maximum string length: 50
enrich_type
string | null
required
Maximum string length: 100
prompt_text
string
required
tone_of_voice
string | null
required
Maximum string length: 50
custom_tone
string | null
required
Maximum string length: 255
purpose
string | null
required
Maximum string length: 50
industry
string | null
required
Maximum string length: 50
point_of_view
string | null
required
Maximum string length: 50
include_spec_table
boolean
required
title_max_length
integer
required

Max character length for generated titles (titles enrichment only).

title_variants
integer
required

How many distinct title variants to generate per product (titles enrichment only).

title_include_brand
boolean
required

Include the brand name in generated titles when known (titles enrichment only).

target_size
string
required

Length preset for description / short_description enrichment.

Maximum string length: 20
target_word_count
integer | null
required

Explicit word target, used when target_size is 'custom'.

faq_types
any
required

FAQ type keys (products/services/faq_types.py); empty uses the industry defaults.

faq_max_questions
integer | null
required

Maximum FAQ items per product, 1 to 20 (faq enrichment only).

faq_use_web_research
boolean | null
required

Ground FAQ answers in the latest web research (faq enrichment only).

target_attribute_codes
any
required

Attribute codes a product_attributes prompt fills; empty fills every AI-enrichable attribute.

share_with_project
boolean
required

When true, other members of the prompt's project can see and use this prompt.

id
integer
required