Skip to main content
POST
Write or clear the note on a saved version

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Needed only when the server has a key configured.

Path Parameters

sessionId
string
required

The unique identifier of the session

workflowId
string
required

The unique identifier of the workflow

Query Parameters

version
string
required

Version id from the list

note
string
default:""

The note; blank clears it

Response

200 - */*

OK

Unified API response wrapper for both success and error responses. Success responses include data field; error responses include error, path, and errors fields.

timestamp
string<date-time>

The time the response was generated

status
integer<int32>

The HTTP status code

Example:

200

message
string

A human-readable message

Example:

"Operation successful"

data
object

The response data

error
string

The HTTP status error name

Example:

"Bad Request"

path
string

The request path

Example:

"/api/files"

errors
object[]

The list of field validation errors