Update Scenario
PATCH/api/v2/pro-forma/scenarios/:scenarioId
Partially update a saved scenario. All fields optional (sometimes): name, channel_type, product_id, integration_instance_id, inputs, outputs, rate_card_version.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
inputs and outputs, when present, are FULL snapshots — last write wins, no deep merge.
Returns 404 when the scenario does not exist or belongs to another user.
Requires Bearer token (products scope).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.