Skip to main content
POST
Preview relationship changes affecting stewardship plans

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

command
enum<string>
required

Command. Validation: required; allowed values: relationship_group_create_or_update, relationship_group_assignment, relationship_group_deactivate.

Available options:
relationship_group_create_or_update,
relationship_group_assignment,
relationship_group_deactivate
Example:

"relationship_group_create_or_update"

operation
enum<string>
required

Operation. Validation: required; allowed values: create, update, assignment, deactivate.

Available options:
create,
update,
assignment,
deactivate
Example:

"create"

relationship_group_id
integer | null

Relationship group id. Validation: nullable, integer, min:1.

Required range: x >= 1
Example:

1

payload
object | null

Proposed relationship payload. Core, links and assignment fields are interpreted for the selected operation; separate relationship mutation validation still applies.

Response

Operation result.

status
string
Example:

"success"

data
object

Preview only: does not mutate the relationship or plan. Impact confirmation must accompany the separate relationship mutation.