Event Types

Update an event type

Updates an existing event type. Only the fields sent are changed. Sending cadence_amount or cadence_unit (null included) requires data capture rate to be enabled for your account (feature_data_capture_rate in GET /feature_flags); otherwise returns 422 “cadence_amount and cadence_unit require feature_data_capture_rate” and nothing is saved. Requests that leave out both fields are not gated. PUT behaves the same. Requires the read:project and write:event_type token scopes.

PATCH

projects

{project_id}

event_types

{event_type_id}

Update an event type

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": {
    "name": "Updated Biochar Production",
    "description": "Updated description"
  }
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}"

payload = { "event_type": {
        "name": "Updated Biochar Production",
        "description": "Updated description"
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: {name: 'Updated Biochar Production', description: 'Updated description'}
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}', 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.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => [
        'name' => 'Updated Biochar Production',
        'description' => 'Updated description'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}"

	payload := strings.NewReader("{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "et_aBcD1234eFgH5678",
  "slug": "biochar-production",
  "name": "Updated Biochar Production",
  "description": "Updated description",
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T12:00:00.000Z",
  "archived_at": null,
  "data_point_types": [],
  "requires_locations": true,
  "requires_tracking_id": true,
  "requires_feedstock": false,
  "requires_asset": false,
  "reusable_in_batches": false,
  "cadence_amount": null,
  "cadence_unit": null,
  "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

event_type_id

string

required

The event type's friendly ID (e.g. et_aBcD1234eFgH5678).

Body

application/json

event_type

object

required

Show child attributes

Response

The updated event type.

string

The event type's friendly ID (e.g. et_aBcD1234eFgH5678).

Example:

"et_aBcD1234eFgH5678"

slug

string | null

name

string | null

description

string | null

created_at

string<date-time>

updated_at

string<date-time>

archived_at

string<date-time> | null

data_point_types

object[]

Show child attributes

requires_locations

boolean

True when expected_locations is two.

requires_tracking_id

boolean

requires_feedstock

boolean

requires_asset

boolean

reusable_in_batches

boolean

cadence_amount

integer<int32> | null

How often an event of this type is expected, as a count of cadence_unit. An event type carries both cadence fields or neither; both null means no cadence is declared, which the app shows as Irregular.

Required range: x >= 1

Example:

15

cadence_unit

enum<string> | null

The unit cadence_amount counts. second, minute and hour measure elapsed time; day and above are calendar periods advanced in the account's time zone, so 1 day and 24 hour are different declarations and a daily stream stays on local midnight across a clock change. From month up, a reading counts toward the period that contains it rather than the nearest period boundary, so a monthly reading taken on the 28th still counts for that month.

Available options:

second,

minute,

hour,

day,

week,

month,

year,

null

Example:

"minute"

ui_url

string<uri>

Link that opens this event type in the Mangrove app.

Example:

"https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"

Update an event type

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": {
    "name": "Updated Biochar Production",
    "description": "Updated description"
  }
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}"

payload = { "event_type": {
        "name": "Updated Biochar Production",
        "description": "Updated description"
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: {name: 'Updated Biochar Production', description: 'Updated description'}
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}', 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.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => [
        'name' => 'Updated Biochar Production',
        'description' => 'Updated description'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}"

	payload := strings.NewReader("{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types/{event_type_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": {\n    \"name\": \"Updated Biochar Production\",\n    \"description\": \"Updated description\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "et_aBcD1234eFgH5678",
  "slug": "biochar-production",
  "name": "Updated Biochar Production",
  "description": "Updated description",
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T12:00:00.000Z",
  "archived_at": null,
  "data_point_types": [],
  "requires_locations": true,
  "requires_tracking_id": true,
  "requires_feedstock": false,
  "requires_asset": false,
  "reusable_in_batches": false,
  "cadence_amount": null,
  "cadence_unit": null,
  "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Update an event type

Authorizations

Path Parameters

Body

Response