Skip to main content
POST
← Custom Emission Factors A record is one emission factor. Its id is what your data references, e.g. custom_ef_record_id in POST /v2/wastes.
Beta. Part of the custom emission factors API, currently in beta. The contract may still change before general availability.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa
string
required
Must be application/json
uuid
required
The database id.Example: 5f1c2e7a-3b4d-4e8f-9a01-2c3d4e5f6a7b
uuid
required
The version id (id of the version).Example: 7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d

Body Parameters

string
required
Record name, 1 to 255 characters. Make it recognizable: it is what users pick from.Example: "Mixed packaging - Ecoveza plant"
uuid
required
Unit of the activity the factor applies to (e.g. kilogram for wastes). Must match the unit your data will be in.Example: "61743a63-ff70-459c-9567-5eee8f7dfd5c"
string
required
Which gases the record carries.Available values: simple (one co2e factor), advanced (one co2, one ch4 and one n2o), full (one of each: co2e, co2, ch4, n2o).
array[string]
required
At least one category that may use the record, e.g. ["wastes"]. See Activity categories.
array[object]
required
The factor values, one per gas, matching tag. Each gas may appear once.
boolean
default:"true"
Disabled records stay in the database but new data cannot use them.
boolean
default:"false"
Report the CO2 factor as biogenic. Requires a co2 factor, and only the stationary, process and transport categories.
number | null
Renewable share between 0 and 1. Electricity categories only.
number
default:"0"
Uncertainty grade of the factor.

Response

The created record (201 Created):
uuid
Record id: the value your data references (e.g. custom_ef_record_id on a waste).
string
Record name.
uuid
Unit of the activity the factor applies to.
uuid
Version the record belongs to.
string
Available values: simple, advanced, full.
array[string]
Categories that can use the record.
boolean
Only enabled records can be used by new data.
boolean
Whether the CO2 factor is reported as biogenic.
number | null
Renewable share (electricity only).
number
Uncertainty grade.
string | null
URL of the first evidence document, if any.
array[object]
Evidence documents: file_id, file_name, file_url, size_kb.
array[object]
One per gas.

Common Errors

401 Unauthorized

Missing or invalid API key.

403 Forbidden

LOGGED_USER_NOT_MEMBER: the API key’s user is not a member of the organization in x-organization-id.

404 Not Found

CUSTOM_DATABASE_NOT_FOUND or CUSTOM_VERSION_NOT_FOUND: the database or version does not exist or is not visible to your organization.

403 CUSTOM_DATABASE_NOT_OWNER

Only the organization that owns the database can create or change its records.

422 Unprocessable Entity

A malformed body (missing field, wrong type) answers the standard validation format: {"detail": [{"loc": [...], "msg": "...", "type": "..."}]}.

Get Record

One record by id

Update Record

Change a record