PATCH
/
removals
/
{id}
curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/removals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "add_components": [
    {
      "attribution_factor_datapoint_id": "dtp_1DVKHKS101S0Q61Q",
      "component_id": "cmp_1EP2SB7MZ1S036PY",
      "process_step_key": "<string>"
    }
  ],
  "add_label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "completed_on": "2023-12-25",
  "delete_component_ids": [
    "cmp_1EP2SB7MZ1S036PY"
  ],
  "delete_label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "started_on": "2023-12-25"
}'
{
  "co2e_net_removed_kg": 123,
  "co2e_net_removed_standard_deviation_kg": 123,
  "co2e_net_removed_without_discount_kg": 123,
  "completed_on": "2023-12-25",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "started_on": "2023-12-25",
  "supplier_reference_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required

Body

application/json
​
add_components

Components to be added to Removal.

​
add_label_ids

Labels to add to Removal.

​
completed_on
string | null

The date by which activities related to this removal finished.

​
delete_component_ids

IDs for components to delete from Removal.

​
delete_label_ids

IDs of the labels to delete from Removal.

​
feedstock_type_id
default:
{"__typename":"Undefined"}

ID of the feedstock type for the Removal.

Required string length: 20 - 36
Example:

"ftt_1D7KZ1P761S0G7BN"

​
started_on
string | null

The date at which activities related to this removal started.

Response

200
application/json
Successful Response
​
co2e_net_removed_kg
number
required

The CO₂e removed by this removal once uncertainty discounting has been applied

​
co2e_net_removed_standard_deviation_kg
number | null
required

The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the removal

​
co2e_net_removed_without_discount_kg
number
required

The CO₂e removed by this removal before any uncertainty discounting has been applied

​
completed_on
string
required
​
feedstock_type_id
string | null
required

The feedstock type ID that this removal is associated with.

Required string length: 20 - 36
Example:

"ftt_1D7KZ1P761S0G7BN"

​
ghg_statement_id
string | null
required

The GHG statement ID that this removal is associated with. If null, the removal is in draft and has not been submitted for verification.

Required string length: 20 - 36
Example:

"ggs_1GDQJ99Z51S0DYW9"

​
id
string
required
Required string length: 20 - 36
Example:

"rmv_1EEM6NJXX1S0EXKD"

​
label_ids
string[]
required

The label IDs that this removal is associated with.

​
started_on
string
required
​
supplier_reference_id
string | null
required

Was this page helpful?

Post RemovalDelete Removal