Skip to main content
POST
← Custom Emission Factors A database groups your organization’s custom factors. Create one per origin of factors (your own measurements, a supplier, a study…).
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

Body Parameters

string
required
Technical name, 1 to 255 characters. It must be unique across all of Dcycle (public databases included), so prefix it with your company, e.g. acme-measured-factors.Example: "acme-measured-factors"
string
required
Name shown in the platform, 1 to 255 characters.Example: "Acme measured factors"
string | null
Long name. Defaults to display_name.
string | null
Free text: where the factors come from.
string | null
Reference URL, up to 2,048 characters.
array[string] | null
ISO 3166-1 alpha-2 codes the factors apply to.Example: ["ES"]
string
default:"all_descendants"
Who in your group can use the database.Available values: all_descendants (every subsidiary), private (only your organization), selected (the subsidiaries you share it with explicitly).

Response

The created database (201 Created):
uuid
Database id.
string
Unique technical name.
string
Name shown in the platform.
string
Long name; defaults to display_name.
string | null
Free text.
string | null
Reference URL.
array[string] | null
ISO 3166-1 alpha-2 codes the factors apply to.
uuid
Owning organization.
string | null
Owning organization’s name.
string
Who in the group can use it. Available values: private, all_descendants, selected.
string | null
Logo URL.
integer
Number of versions.

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.

409 CUSTOM_DATABASE_NAME_EXISTS

A database (yours, another organization’s or a public one) already has that name. Choose another.

422 Validation Error

A missing or too long field.

Create Version

Next step: a version of the database

List Databases

Databases visible to your organization