Update one of your saved model scenarios

PATCH

https://api.sureshake.com/v2/entities/{id}/models/{templateKey}/scenarios/{scenarioId}

Path parameters

id
string
required
format: uuid

templateKey
string
required
maxLength: 64 · minLength: 1
scenarioId
string
required
format: uuid

Request body JSON

name
optional
string
maxLength: 120 · minLength: 1
assumptions
optional
map of
number
drivers
optional
object
- revenue_growth
  map of
  number
  required
- ebitda_margin
  map of
  number
  required
- other_income
  map of
  number
  required
- capex_pct_revenue
  map of
  number
  required
- nwc_pct_revenue
  map of
  number
  required
- da_pct_revenue
  map of
  number
  required
- tax_rate
  map of
  number
  required
}

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- templateKey
  string
  required
- name
  string
  required
- assumptions
  map of
  number
  required
- drivers
  object
  required
  revenue_growth
  map of
  number
  required
  ebitda_margin
  map of
  number
  required
  other_income
  map of
  number
  required
  capex_pct_revenue
  map of
  number
  required
  nwc_pct_revenue
  map of
  number
  required
  da_pct_revenue
  map of
  number
  required
  tax_rate
  map of
  number
  required
- shareToken
  string
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request PATCH \ --url 'https://api.sureshake.com/v2/entities/<id>/models/<templateKey>/scenarios/<scenarioId>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "assumptions": { "property1": 0, "property2": 0 }, "drivers": { "revenue_growth": { "property1": 0, "property2": 0 }, "ebitda_margin": { "property1": 0, "property2": 0 }, "other_income": { "property1": 0, "property2": 0 }, "capex_pct_revenue": { "property1": 0, "property2": 0 }, "nwc_pct_revenue": { "property1": 0, "property2": 0 }, "da_pct_revenue": { "property1": 0, "property2": 0 }, "tax_rate": { "property1": 0, "property2": 0 } } } '

{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "templateKey": "string", "name": "string", "assumptions": { "property1": 0, "property2": 0 }, "drivers": { "revenue_growth": { "property1": 0, "property2": 0 }, "ebitda_margin": { "property1": 0, "property2": 0 }, "other_income": { "property1": 0, "property2": 0 }, "capex_pct_revenue": { "property1": 0, "property2": 0 }, "nwc_pct_revenue": { "property1": 0, "property2": 0 }, "da_pct_revenue": { "property1": 0, "property2": 0 }, "tax_rate": { "property1": 0, "property2": 0 } }, "shareToken": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }