---
title: "Forecasts.batch_create_or_update"
method: POST
path: "/entities/Forecasts/batch-modify"
tags: ["Forecast"]
---

# Forecasts.batch_create_or_update

`POST /entities/Forecasts/batch-modify`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Forecasts/batch-modify`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Forecasts/batch-modify/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates or updates Forecast records in one request: an item with an id updates that record, an item without one creates a new record.

## Query parameters

- `validation-level` integer
- `rollback-method` 0 | 1

## Request body

- BatchForecastInput[]
  - `description` string: Free-text description shown alongside the forecast.
  - `name` string: Name of the entity and its default text representation.
  - `owner_id` string, uuid: Id of the owning user.
  - `settings` object: Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/b/#BetterForecastSchema This payload conforms to the `BetterForecastSchema` JSON Schema (see the linked schema).
  - `share_mode` 0 | 1 | 2 | 3: Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see shared_clients and shared_units) and stores the mode as Standard. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
  - `share_mode_params` string: Legacy additional sharing options; kept with the record but no longer applied.
  - `revision` integer: Revision when entity was lastly changed.
  - `shared_clients` object[]: Users granted shared access to this forecast (custom share mode).
    - `id` string, uuid: Id of the related Client record.
  - `shared_units` object[]: Sales units granted shared access to this forecast (custom share mode).
    - `id` string, uuid: Id of the related SalesUnit record.
  - `id` string, uuid: ID of object to update.

## Response `200`

Result per item, in request order: the id of the created or updated record, or the error.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` union[]
    - union
      - string, uuid: Id of the created or updated record.
      - Error: The body of every REST error. `code` and `name` are stable identifiers; `message` is for people. The full list of codes is at https://developers.coevera.com/reference/errors/.
        - `http_status` integer, required: HTTP status code.
        - `code` integer: Numeric code of the API error.
        - `name` string: Name of the API error.
        - `message` string: Message describing the error.
        - `success` boolean, required: Always false on error.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)