Skip to main content
PATCH
Update Historical Emission
← Historical Emissions Update one or more fields of an existing historical emission entry of your organization or of a company of its group you can write to. Only send the fields you want to change — all fields are optional.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the historical emission entryExample: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body Parameters

All fields are optional — only send what you want to change.
string
Moves the entry, and its share of the totals, to another company of your group you can write to (403 Forbidden otherwise, and for a caller that is not a non-Viewer member user). A file private to the company it leaves is detached.
string
Start date (ISO 8601)
string
End date. Must be >= start_date when both are provided.
string
Emission category (see Create for full list)
number
Total CO2e in kilograms (must be > 0)
string
Free text description
string
UUID of evidence file. It must be a file of your organization (or of a subsidiary you can write to); any other id returns 404 Not Found.
string
URL of evidence file
string
Name of evidence file (max 255 chars)

Response

Returns the updated historical emission object with HTTP 200.
string
Historical emission UUID
string
Organization UUID
date
Start date of the emission period (ISO 8601)
date
End date of the emission period (ISO 8601)
integer
GHG scope automatically derived from category (1, 2, or 3)
string
Emission category (e.g. electricity, transport, purchases)
number
Total CO2e emissions in kilograms
string | null
Free text description of the emission entry
string
GHG gas type (e.g. co2e)
integer
GHG type: 0 = fossil, 1 = biomass
boolean
Whether this emission entry is enabled and included in totals
string | null
UUID of the attached evidence file
string | null
URL of the attached evidence file
string | null
Name of the attached evidence file
string | null
How the entry was created: manual (the app’s form or this API), bulk_file (a spreadsheet import in the app; source_file_id is that spreadsheet) or estimation (an employee commuting estimation). Null on entries created before 2026-10-23.
string | null
UUID of the spreadsheet a bulk_file entry was imported from. Apart from file_id, which is only the evidence attached to the entry. Null on every other entry.
datetime
Creation timestamp (ISO 8601)
string | null
Last update timestamp (ISO 8601)

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: Historical emission not found (or not in your group, or in a company you cannot write to), or file_id is not a file your organization can attach

Get

View the current entry

List

View all entries