Skip to main content
POST
Record a stewardship-plan review

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

plan_id
integer
required

Plan id in the current organization.

Body

application/json

Validated request fields for this operation.

version
integer
required

Current plan version for optimistic concurrency. Stale versions return 409.

Required range: x >= 1
Example:

1

review_type
enum<string>
required

Review type. Validation: required; allowed values: strategy, periodic, annual, stage_change.

Available options:
strategy,
periodic,
annual,
stage_change
Example:

"strategy"

summary
string
required

Summary. Validation: required, string, max:5000.

Maximum string length: 5000
Example:

"Summary"

outcome
string | null

Outcome. Validation: nullable, string, max:32.

Maximum string length: 32
Example:

"Outcome"

Response

Operation result.

status
string
Example:

"success"

data
object