Skip to main content
PATCH
← Custom Emission Factors Send only the fields to change. factors, when sent, replaces all of the record’s factors.
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
uuid
required
The record id.Example: c3d4e5f6-a7b8-9012-cdef-ab3456789012

Body Parameters

The fields of Create Record, all optional: name, unit_id, tag, activity_categories, factors, enabled, is_biogenic, renewable_percentage, uncertainty_grade.
Changing unit_id, tag or is_biogenic requires sending factors too (422 CUSTOM_RECORD_FACTORS_REQUIRED). Once data uses the record, its factors and activity_categories can no longer be changed (409 CUSTOM_RECORD_IN_USE): create a new record instead, or disable this one with "enabled": false.

Response

The updated record:
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.

404 CUSTOM_RECORD_NOT_FOUND

The record does not exist in that version or is not visible.

409 CUSTOM_RECORD_IN_USE

Data already uses the record, so its factors or activity categories cannot change.

422 Unprocessable Entity

A malformed body (missing field, wrong type) answers the standard validation format: {"detail": [{"loc": [...], "msg": "...", "type": "..."}]}. Also CUSTOM_RECORD_FACTORS_REQUIRED: unit_id, tag or is_biogenic changed without new factors.

Get Record

One record by id

Delete Record

Remove a record