Skip to content

Update Promise

PUT
/api/creative/plot/promises/{promise_id}

Update a promise.

promise_id
required
Promise Id
string
PromiseUpdateRequest

Update a narrative promise.

object
title
Any of:
string
>= 1 characters <= 500 characters
description
Any of:
string
promiseType
Any of:
string
Allowed values: tone genre plot character
promiseLevel
Any of:
string
Allowed values: story act scene
status
Any of:
string
Allowed values: made in_progress fulfilled broken
madeAtNodeId
Any of:
string
fulfilledAtNodeId
Any of:
string
plotlineId
Any of:
string
notes
Any of:
string

Successful Response

PromiseResponse

Single promise response.

object
status
required
Status

Operation status

string
data
required
PlotPromise

The promise

object
id
required
Id

Promise UUID

string
projectId
required
Projectid

Owning project

string
title
required
Title

Promise title

string
description
Description

What is being promised

string
""
promiseType
Promisetype

Promise classification

string
default: plot
Allowed values: tone genre plot character
promiseLevel
Promiselevel

Scope level

string
default: story
Allowed values: story act scene
status
Status

Fulfillment status

string
default: made
Allowed values: made in_progress fulfilled broken
madeAtNodeId
Any of:
string
fulfilledAtNodeId
Any of:
string
plotlineId
Any of:
string
notes
Notes

Author notes

string
""
madeAtNodeTitle
Madeatnodetitle

Made node title (denormalized)

string
""
fulfilledAtNodeTitle
Fulfilledatnodetitle

Fulfilled node title (denormalized)

string
""
plotlineTitle
Plotlinetitle

Plotline title (denormalized)

string
""
createdAt
required
Createdat

Created timestamp (ms)

integer
modifiedAt
required
Modifiedat

Modified timestamp (ms)

integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object