Skip to main content
PUT
/
v1
/
dataset
/
{uuid}
/
impacts
Set a dataset's impact indicators
curl --request PUT \
  --url https://app.variable.global/api/v1/dataset/{uuid}/impacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "GWP-fossil": {
    "A1": "4",
    "A3": "6"
  },
  "ODP": {
    "A1": "1.2e-6"
  }
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Steel billet, hot rolled",
  "description": "A descriptive description",
  "notes": "Internal notes about this product",
  "sku": "SKU123",
  "syncId": "sync123",
  "cpcCode": "CPC123",
  "unit": "kg",
  "footprint": {
    "CO2e": {
      "A1": "1200.0",
      "A2": "30.0",
      "A3": "4.0",
      "A4": "0.5",
      "B1": "0.06",
      "B2": "0.007",
      "B3": "0.0008",
      "B4": "",
      "B5": "",
      "C1": "",
      "C2": "",
      "C3": "",
      "C4": "",
      "D": "",
      "totalCarbonFootprint": "1234.5678",
      "productCarbonFootprint": "1234.0",
      "upstream": "1230.0",
      "direct": "4.0",
      "downstream": "0.5678",
      "A1_A3": "1234.0"
    }
  },
  "dataQualityIndicators": {
    "documentationYear": 2019,
    "coveragePercent": 80,
    "specificPercent": 40,
    "technologicalDQR": 1,
    "geographicalDQR": 1,
    "completenessDQR": 1,
    "reliabilityDQR": 1,
    "averagePercent": 60,
    "temporalDQR": 3
  },
  "taxonomy": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Material",
    "path": "material"
  },
  "geoLocation": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh, PA"
  },
  "location": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh Office"
  },
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z",
  "image": "https://app.variable.global/uploads/image.jpg",
  "impacts": {
    "GWP-fossil": {
      "unit": "kgCO2e",
      "method": "Mixed",
      "totalCarbonFootprint": "10",
      "A1_A3": "10"
    },
    "ODP": {
      "unit": "kgCFC11e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "0.0000012"
    },
    "AP": {
      "unit": "molH+e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "2"
    }
  },
  "dataQualityRating": 1.4,
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-31T23:59:59.000Z",
  "supplier": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "syncId": "sync123",
    "name": "Company Name"
  }
}
Requires permission:
Impacts are keyed by canonical EN 15804+A2 indicator code — the same vocabulary the read endpoints return. Send only life-cycle stage values (A1–A5, B1–B7, C1–C4, D); totals are computed server-side. The dataset must be in draft state, and indicators you omit are left unchanged.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
uuid
string<uuid>
required

Body

application/json

Impact indicators keyed by canonical EN 15804+A2 code (e.g. GWP-fossil, ODP, AP), case-insensitive. An unknown code returns 400. Indicators you omit are left unchanged.

​
{key}
object

Life-cycle stage values for one indicator — A1–A5, B1–B7, C1–C4, D — as numbers, numeric strings, or null (clears the stage). At least one stage is required. Sending an indicator replaces its full stage profile: any stage you omit is cleared, so send every stage you want kept. Totals (A1_A3, upstream, direct, downstream, productCarbonFootprint, totalCarbonFootprint) are derived server-side and ignored if sent.

Example:
{ "A1": "4", "A3": "6" }

Response

The updated dataset

​
uuid
string<uuid>
​
name
string
Example:

"Steel billet, hot rolled"

​
description
string
Example:

"A descriptive description"

​
notes
string
Example:

"Internal notes about this product"

​
sku
string
Example:

"SKU123"

​
syncId
string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

​
cpcCode
string
Example:

"CPC123"

​
unit
string

The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.

Example:

"kg"

​
footprint
object
deprecated

Deprecated — use impacts["GWP-fossil"]. Kept for backwards compatibility.

​
dataQualityIndicators
object
​
taxonomy
object

A reference to a taxonomy category, including its machine-readable path.

​
geoLocation
object
​
location
object
​
startDate
string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

​
endDate
string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

​
image
string
Example:

"https://app.variable.global/uploads/image.jpg"

​
impacts
object

Environmental impact indicators keyed by canonical code (e.g. GWP-fossil, ODP, AP). Which indicators appear is controlled by the impacts query parameter — by default only GWP-fossil is returned.

Example:
{
  "GWP-fossil": {
    "unit": "kgCO2e",
    "method": "Mixed",
    "totalCarbonFootprint": "10",
    "A1_A3": "10"
  },
  "ODP": {
    "unit": "kgCFC11e",
    "method": "EN15804+A2 - Core impact categories and indicators",
    "A1_A3": "0.0000012"
  },
  "AP": {
    "unit": "molH+e",
    "method": "EN15804+A2 - Core impact categories and indicators",
    "A1_A3": "2"
  }
}
​
dataQualityRating
number
Example:

1.4

​
created
string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

​
updated
string

ISO 8601 date

Example:

"2021-01-31T23:59:59.000Z"

​
supplier
object