Skip to main content
POST
Update Suggestion

Authorizations

api_key
string
header
required

Body

application/json
oId
string
required

The suggestion oId to revise (from suggestion/list). Only pending suggestions can be revised.

Example:

"esug_abc123"

instructions
string

REGENERATE mode. Natural-language instructions for how to change the proposal — e.g. 'make the description more concise'. The proposed content is regenerated by AI. Combine with edits to regenerate first, then apply precise overrides on top.

edits
object

OVERRIDE mode. A partial patch of fields on the proposed entity — only the keys you provide change; arrays replace wholesale, objects deep-merge. No AI regeneration runs. Use this to surgically fix one detail of an otherwise-good proposal. Inspect the current proposal with suggestion/get first to see the field shape.

mode
enum<string>
default:replace

Applies to instructions only: 'replace' (default) swaps the prior instruction for this one; 'append' layers it on top.

Available options:
replace,
append

Response

The revised suggestion preview

_metadata
object
required
data
object
required