Forecasts.update

PATCH

/entities/Forecasts/{id}

Modifies Forecast or Forecasts with given id(s)

Request

Path Params

Query Params

Body Params application/json

Example

{
    "description": "string",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": {},
    "share_mode": 0,
    "share_mode_params": 1,
    "revision": 1,
    "shared_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "shared_units": [
        {
            "id": "http://example.com"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/entities/Forecasts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": {},
    "share_mode": 0,
    "share_mode_params": 1,
    "revision": 1,
    "shared_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "shared_units": [
        {
            "id": "http://example.com"
        }
    ]
}'

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting Forecast

Body

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "field": "http://example.com",
        "owner": "http://example.com",
        "pipeline": "http://example.com",
        "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",
        "settings": {},
        "share_mode": 0,
        "share_mode_params": 1,
        "start_date": "2019-01-01",
        "type": {},
        "revision": 1,
        "shared_clients": [
            "http://example.com"
        ],
        "shared_units": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Modified at 2025-07-24 11:25:52

Forecasts.delete

Forecasts.list