Rename or describe a saved version

PATCH/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}

Update a saved version's name or description.

Configuration and snapshot fields are immutable — save a new version to capture a new scenario.

Operation ID: cfo_portal_update_version_api_v1_businesses__business_id__cfo_portal_cash_forecast_versions__version_id__patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired
version_idstringrequired

Request body

Schema: CashForecastVersionUpdate

namestring
descriptionstring

Responses

200Successful Response

Schema: SuccessEnvelope_CashForecastVersionDetail_

successboolean
messagestring
codestring
dataCashForecastVersionDetail

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PATCH/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string"
}'