Skip to main content
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",
    "path": "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"
}
'
import requests

url = "https://app.variable.global/api/v1/activity"

payload = {
    "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",
        "path": "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
      path: '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'
  })
};

fetch('https://app.variable.global/api/v1/activity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.variable.global/api/v1/activity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
        'path' => '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.variable.global/api/v1/activity"

	payload := strings.NewReader("{\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Name\",\n  \"created\": \"2021-01-01T00:00:00.000Z\",\n  \"updated\": \"2021-01-31T23:59:59.000Z\",\n  \"syncId\": \"sync123\",\n  \"description\": \"<string>\",\n  \"quantity\": 150,\n  \"unit\": \"kg\",\n  \"UpstreamCO2e\": \"1234\",\n  \"DownstreamCO2e\": \"0.5678\",\n  \"product\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Product Name\"\n  },\n  \"scope\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Scope 2: Electricity\"\n  },\n  \"taxonomy\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Material\",\n    \"path\": \"material\"\n  },\n  \"org\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Org Unit\"\n  },\n  \"startDate\": \"2021-01-01T00:00:00.000Z\",\n  \"endDate\": \"2021-01-01T00:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.variable.global/api/v1/activity")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Name\",\n  \"created\": \"2021-01-01T00:00:00.000Z\",\n  \"updated\": \"2021-01-31T23:59:59.000Z\",\n  \"syncId\": \"sync123\",\n  \"description\": \"<string>\",\n  \"quantity\": 150,\n  \"unit\": \"kg\",\n  \"UpstreamCO2e\": \"1234\",\n  \"DownstreamCO2e\": \"0.5678\",\n  \"product\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Product Name\"\n  },\n  \"scope\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Scope 2: Electricity\"\n  },\n  \"taxonomy\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Material\",\n    \"path\": \"material\"\n  },\n  \"org\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Org Unit\"\n  },\n  \"startDate\": \"2021-01-01T00:00:00.000Z\",\n  \"endDate\": \"2021-01-01T00:00:00.000Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.variable.global/api/v1/activity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Name\",\n  \"created\": \"2021-01-01T00:00:00.000Z\",\n  \"updated\": \"2021-01-31T23:59:59.000Z\",\n  \"syncId\": \"sync123\",\n  \"description\": \"<string>\",\n  \"quantity\": 150,\n  \"unit\": \"kg\",\n  \"UpstreamCO2e\": \"1234\",\n  \"DownstreamCO2e\": \"0.5678\",\n  \"product\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Product Name\"\n  },\n  \"scope\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Scope 2: Electricity\"\n  },\n  \"taxonomy\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Material\",\n    \"path\": \"material\"\n  },\n  \"org\": {\n    \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"Org Unit\"\n  },\n  \"startDate\": \"2021-01-01T00:00:00.000Z\",\n  \"endDate\": \"2021-01-01T00:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "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",
    "path": "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"
}
{
  "message": "token expired"
}
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
​
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

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

​
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"

Response

Activity data

​
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

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

​
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"

​
CO2e
string
Example:

"1234.5678"