v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Forecast

Forecasts.update

Modifies Forecast or Forecasts with given id(s)

patch/entities/Forecasts/{id}

Path parameters

idstring uuid required

ID of Forecast to update

Query parameters

validation-levelinteger

Specify validation level of Forecast on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

descriptionstring

Free-text description shown alongside the forecast.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the owning user.

settingsobject

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://graphql.api-doc.pipelinersales.com/latest/graphql/space/betterforecastschema.doc.html

share_mode0 | 1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

share_mode_paramsstring

Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users).

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "description": "string",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting Forecast

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "end_date": "2019-01-01",
    "field_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_date": "2019-01-01",
    "revision": 1
  }
}