POST
/
v1
/
activity
Create an activity
curl --request POST \
  --url https://app.variable.global/api/v1/activity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Name",
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-31T23:59:59.000Z",
  "syncId": "sync123",
  "description": "<string>",
  "quantity": 150,
  "unit": "kg",
  "UpstreamCO2e": "1234",
  "DownstreamCO2e": "0.5678",
  "product": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Product Name"
  },
  "scope": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Scope 2: Electricity"
  },
  "taxonomy": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Material"
  },
  "org": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Org Unit"
  },
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z"
}'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Name",
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-31T23:59:59.000Z",
  "syncId": "sync123",
  "description": "<string>",
  "quantity": 150,
  "unit": "kg",
  "UpstreamCO2e": "1234",
  "DownstreamCO2e": "0.5678",
  "product": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Product Name"
  },
  "scope": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Scope 2: Electricity"
  },
  "taxonomy": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Material"
  },
  "org": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Org Unit"
  },
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z",
  "CO2e": "1234.5678"
}
Requires permission:
Read more about the Activity data models.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
syncId
string

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

Example:

"sync123"

​
description
string
​
quantity
number
Example:

150

​
unit
string

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

Example:

"kg"

​
UpstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"1234"

​
DownstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"0.5678"

​
product
object
​
scope
object
​
taxonomy
object
​
org
object
​
uuid
string<UUID>
​
name
string
Example:

"Name"

​
created
string

ISO 8601 date

Example:

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

​
updated
string

ISO 8601 date

Example:

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

​
startDate
string

ISO 8601 date

Example:

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

​
endDate
string

ISO 8601 date

Example:

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

Response

Activity data

​
CO2e
string
Example:

"1234.5678"

​
uuid
string<UUID>
​
name
string
Example:

"Name"

​
created
string

ISO 8601 date

Example:

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

​
updated
string

ISO 8601 date

Example:

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

​
syncId
string

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

Example:

"sync123"

​
description
string
​
quantity
number
Example:

150

​
unit
string

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

Example:

"kg"

​
UpstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"1234"

​
DownstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"0.5678"

​
product
object
​
scope
object
​
taxonomy
object
​
org
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"