v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Forecasts

Update forecast

Updates the synchronization status or additional info of a forecast identified by id. Fields omitted from the request, or sent as null, are left unchanged. Updating an id that does not match any forecast also returns 200 without applying any change — no 404 is raised.

patch/forecasts/{companyId}/{id}

Path parameters

idstring required

companyIdstring required

Request body

additionalInfoobject

Free-form key/value metadata to attach to the forecast.

syncboolean nullable

Marks the forecast as synchronized with your systems. Fields omitted from the request, or sent as null, are left unchanged.

Example request

{
  "sync": true
}

Response

Successful Response

idstring required

Embat forecast ID.

Example response

{
  "id": "fct_00123"
}