Rename Model
rename_modelRename a model and/or declare its money currency. Pass name, currency or both.
Instructions
Rename a model and/or declare its money currency. Pass name, currency or both.
The model's saved/unsaved state is untouched (use save_model to file it into a project). The name is HTML-sanitized server-side and must be non-empty.
The currency labels the model's spend and money outcomes everywhere (results, optimiser and scenario runs, PDFs). It changes nothing fitted, so there is no refit. Only the model's owner may set it, and only on a completed model. Refused (409) for a model that is study evidence (change it in a revision of the recipe), for one whose campaign curves were built in another currency, and for one with old-format settings. Never guess a currency: use the one the user or the data states.
Args: model_hash: Hash of the model. name: New display name; leave empty to keep the current one. currency: Uppercase code: GBP, USD, EUR, CAD, AUD, NZD, CHF, SGD, HKD, JPY, KWD, BHD or OMR. Leave empty to keep the current one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| currency | No | ||
| model_hash | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||