Create Scenario
POST/api/v2/pro-forma/scenarios
Save a what-if scenario snapshot for the authenticated user.
Required scope:
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
name(required, string, max 255)channel_type(required, string, max 50) — e.g. amazon, shopify, ebay, customproduct_id(optional, nullable, integer, exists:products) — null for hypothetical products (store the manual profile ininputs.manual_profile)integration_instance_id(optional, nullable, integer, exists:integration_instances)inputs(required, object) — full input snapshot: prices, fee overrides, advanced levers, manual_profileoutputs(required, object) — computed metrics snapshot: net_profit, margin_pct, roi_pct, breakeven_price, ...rate_card_version(optional, nullable, string, max 50) — rate-card version used, enables "superseded rates" prompts
Requires Bearer token (products scope).
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Content-Type
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.
Unprocessable Entity
Response Headers
Content-Type
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.