---
title: "Patch Removal"
method: PATCH
path: "/removals/{id}"
deprecated: true
---

# Patch Removal

`PATCH /removals/{id}`

> **Deprecated.**

Updates a removal in the Isometric system. The removal will be recalculated, if it is are not in an immutable state.

## Path parameters

- `id` string, required

## Headers

- `x-client-secret` string, required — A secret token identifying the client connecting to the API

## Request body

- PatchRemovalRequest
  - `delete_component_ids` union — Deprecated, please use `PATCH /removal/{id}/component_attributions` instead. IDs for components to delete from the removal.
    - string[]
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `add_components` union — Deprecated, please use `PATCH /removal/{id}/component_attributions` instead. Components to be attributed to the removal.
    - AddComponentToRemoval[]
      - `component_id` string, required — ID for component to add to Removal.
      - `process_step_key` string, nullable — Deprecated, please use removal_template_group_id instead. Process step key matching the module the component should be added to.
      - `removal_template_group_id` string, nullable — Which group the component should be added to, based on the removal's template structure.
      - `attribution_factor_datapoint_id` string, nullable, required — A scalar between 0 and 1 for the fraction of the CO2e flux of the component that is to be attributed to this removal. A null input will default to 1.
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `feedstock_type_id` union — ID of the feedstock type for the removal.
    - string
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `started_on` string, date, nullable — Date in ISO format (YYYY-MM-DD)
  - `completed_on` string, date, nullable — Date in ISO format (YYYY-MM-DD)

## Response `200`

Successful Response

- Removal
  - `id` string, required
  - `supplier_reference_id` string, nullable, 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.
  - `started_on` string, date, required
  - `completed_on` string, date, required
  - `co2e_net_removed_kg` number, required — The CO₂e removed by this removal once uncertainty discounting has been applied
  - `co2e_net_removed_without_discount_kg` number, required — The CO₂e removed by this removal before any uncertainty discounting has been applied
  - `co2e_net_removed_standard_deviation_kg` number, nullable, required — The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the removal
  - `ghg_statement_id` string, nullable, 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.
  - `feedstock_type_id` string, nullable, required — The feedstock type ID that this removal is associated with.
  - `risk_of_reversal_percentage` number, nullable, required — The percentage of credits contributed to the buffer pool due to risk of reversal.
  - `credit_allocation` CreditAllocation, required
    - `buffer_pool_contribution_kg` integer, required — The number of credits (in kg CO₂e) contributed to the buffer pool, computed as risk_of_reversal_percentage × total issuable credits.
    - `supplier_allocation_kg` integer, required — The number of credits (in kg CO₂e) issued to the supplier, computed as total issuable credits minus buffer pool contribution.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api.md) · [All operations](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/isometric/isometric-certify-data-ingestion-api/versions/9819e9c8ccf0/schema)