Skip to main content
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

Headers

x-client-secret
string
required
Examples:

Path Parameters

id
string
required

Body

application/json
add_components
deprecated
add_label_ids
completed_on
string<date> | null
delete_component_ids
deprecated
delete_label_ids
feedstock_type_id
default:{"__typename":"Undefined"}
Required string length: 20 - 37
Examples:
started_on
string<date> | null

Response

co2e_net_removed_kg
number
required
co2e_net_removed_standard_deviation_kg
number | null
required
co2e_net_removed_without_discount_kg
number
required
completed_on
string<date>
required
feedstock_type_id
string | null
required
Required string length: 20 - 37
Examples:
ghg_statement_id
string | null
required
Required string length: 20 - 37
Examples:
id
string
required
Required string length: 20 - 37
Examples:
label_ids
string[]
required
started_on
string<date>
required
supplier_reference_id
string | null
required
Required string length: 1 - 100