Batches

Update a batch

Updates a batch’s tracking ID, the only editable field on a batch. The tracking ID is free text — commas and spaces are allowed, so a batch covering several deliveries can carry all of their numbers — and it is what the dashboard and reports show to identify the batch. Send an empty string to clear it. A batch whose tracking ID was computed from its model run cannot be renamed: a model that partitions by tracking ID (including composite partitions such as tracking_id_and_feedstock) stamps each batch from its own partitioning data points, and editing one returns 422. To change those, correct the tracking IDs on the underlying events and regenerate the batch.

PATCH

batches

{batch_id}

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/batches/{batch_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_id": "2356-R, 2357-R, 2358-R"
}
'

{
  "id": "ba_abc123def456",
  "tracking_id": "2356-R, 2357-R, 2358-R",
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z",
  "state": "complete",
  "error_message": null,
  "primary_output": {
    "id": 1,
    "name": "RNG produced",
    "unit": "MMBtu",
    "data_point_type_id": 5,
    "value": 9146
  },
  "has_rule_alerts": false,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-04-02T11:30:00.000Z"
}

{
  "errors": [
    {
      "message": "record not found"
    }
  ]
}

{
  "errors": [
    {
      "message": "Tracking id cannot be changed when computed from model run",
      "field": "tracking_id"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

batch_id

string

required

Batch friendly ID (e.g., ba_abc123def456)

Body

application/json

tracking_id

string

The batch's tracking ID. Send an empty string to clear it.

Response

200

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/batches/{batch_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_id": "2356-R, 2357-R, 2358-R"
}
'

{
  "id": "ba_abc123def456",
  "tracking_id": "2356-R, 2357-R, 2358-R",
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z",
  "state": "complete",
  "error_message": null,
  "primary_output": {
    "id": 1,
    "name": "RNG produced",
    "unit": "MMBtu",
    "data_point_type_id": 5,
    "value": 9146
  },
  "has_rule_alerts": false,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-04-02T11:30:00.000Z"
}

{
  "errors": [
    {
      "message": "record not found"
    }
  ]
}

{
  "errors": [
    {
      "message": "Tracking id cannot be changed when computed from model run",
      "field": "tracking_id"
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Update a batch

Authorizations

Path Parameters

Body

Response