PATCH
/
removals
/
{id}
Patch Removal
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>",
      "removal_template_group_id": "rtg_1EGQ9DZXZ1S05S28"
    }
  ],
  "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>"
}
add_components and delete_components_ids fields are deprecated and will be removed. Please use PATCH Removal Components to add and remove components from a removal.

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

Examples:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required

Body

application/json
​
add_components
deprecated

Deprecated, please use PATCH /removal/{id}/component_attributions instead.

Components to be attributed to the removal.

​
add_label_ids

Labels to add to Removal.

​
completed_on
string<date> | null

The date by which activities related to this removal finished. Date in ISO format (YYYY-MM-DD)

​
delete_component_ids
deprecated

Deprecated, please use PATCH /removal/{id}/component_attributions instead.

IDs for components to delete from the 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 - 37
Examples:

"ftt_1D7KZ1P761S0G7BN"

"ftt_1CSRJN4HHSBXZ3TK"

​
started_on
string<date> | null

The date at which activities related to this removal started. Date in ISO format (YYYY-MM-DD)

Response

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<date>
required
​
feedstock_type_id
string | null
required

The feedstock type ID that this removal is associated with.

Required string length: 20 - 37
Examples:

"ftt_1D7KZ1P761S0G7BN"

"ftt_1CSRJN4HHSBXZ3TK"

​
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 - 37
Examples:

"ggs_1GDQJ99Z51S0DYW9"

"ggs_1FWVEQRWSSBXK3NB"

​
id
string
required
Required string length: 20 - 37
Examples:

"rmv_1EEM6NJXX1S0EXKD"

"rmv_1E3V4J2EWSBX5E82"

​
label_ids
string[]
required

The label IDs that this removal is associated with.

​
started_on
string<date>
required
​
supplier_reference_id
string | null
required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 100