Update Waste

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    identification_name: '<string>',
    description: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    base_quantity: 123,
    destination: '<string>',
    total_km_to_waste_center: 123,
    unit_id: '<string>',
    waste_efs_id: '<string>',
    custom_emission_factor_id: '<string>'
  })
};

fetch('https://api.dcycle.io/v1/wastes/{waste_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/v1/wastes/{waste_id}"

payload = {
    "identification_name": "<string>",
    "description": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "base_quantity": 123,
    "destination": "<string>",
    "total_km_to_waste_center": 123,
    "unit_id": "<string>",
    "waste_efs_id": "<string>",
    "custom_emission_factor_id": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request PATCH \
  --url https://api.dcycle.io/v1/wastes/{waste_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "identification_name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "base_quantity": 123,
  "destination": "<string>",
  "total_km_to_waste_center": 123,
  "unit_id": "<string>",
  "waste_efs_id": "<string>",
  "custom_emission_factor_id": "<string>"
}
'

{
  "id": "<string>",
  "identification_name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "base_quantity": 123,
  "quantity": 123,
  "percentage": 123,
  "destination": "<string>",
  "total_km_to_waste_center": 123,
  "status": "<string>",
  "error_messages": {},
  "co2e": 123,
  "co2e_biomass": 123,
  "enabled": {},
  "file_id": {},
  "file_name": {},
  "file_url": {},
  "created_at": {},
  "updated_at": {}
}

PATCH

wastes

{waste_id}

Update Waste

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    identification_name: '<string>',
    description: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    base_quantity: 123,
    destination: '<string>',
    total_km_to_waste_center: 123,
    unit_id: '<string>',
    waste_efs_id: '<string>',
    custom_emission_factor_id: '<string>'
  })
};

fetch('https://api.dcycle.io/v1/wastes/{waste_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/v1/wastes/{waste_id}"

payload = {
    "identification_name": "<string>",
    "description": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "base_quantity": 123,
    "destination": "<string>",
    "total_km_to_waste_center": 123,
    "unit_id": "<string>",
    "waste_efs_id": "<string>",
    "custom_emission_factor_id": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request PATCH \
  --url https://api.dcycle.io/v1/wastes/{waste_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "identification_name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "base_quantity": 123,
  "destination": "<string>",
  "total_km_to_waste_center": 123,
  "unit_id": "<string>",
  "waste_efs_id": "<string>",
  "custom_emission_factor_id": "<string>"
}
'

{
  "id": "<string>",
  "identification_name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "base_quantity": 123,
  "quantity": 123,
  "percentage": 123,
  "destination": "<string>",
  "total_km_to_waste_center": 123,
  "status": "<string>",
  "error_messages": {},
  "co2e": 123,
  "co2e_biomass": 123,
  "enabled": {},
  "file_id": {},
  "file_name": {},
  "file_url": {},
  "created_at": {},
  "updated_at": {}
}

Update Waste

Update specific fields of an existing waste record. All fields are optional - only include fields you want to modify. Omitted fields will retain their current values.

CO2e Recalculation: When you update fields like base_quantity, waste_efs_id, or unit_id, CO2e emissions are automatically recalculated.

Request

Path Parameters

uuid

required

The UUID of the waste record to updateExample: 550e8400-e29b-41d4-a716-446655440000

Headers

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Body Parameters

All parameters are optional. Only include fields you want to update.

string

Waste identification name or invoice numberExample: "RSU-2024-001-Updated"

string

Description of the wasteExample: "Updated description"

date

Start date of the waste period. An empty string ("") is treated the same as omitting the field — the existing value is left unchanged.Example: "2024-01-01"

date

End date of the waste period. An empty string ("") is treated the same as omitting the field — the existing value is left unchanged.Example: "2024-06-30"

number

Waste quantity in the specified unit. Must be greater than 0.Example: 2000.0

string

Waste destination or treatment facilityExample: "New waste treatment plant"

number

Distance to waste treatment center in kilometersExample: 30.0

uuid

UUID of the quantity unitExample: "61743a63-ff70-459c-9567-5eee8f7dfd5c"

uuid

UUID of the waste emission factorExample: "770e8400-e29b-41d4-a716-446655440000"

uuid

UUID of a custom emission factorExample: "880e8400-e29b-41d4-a716-446655440000"

Response

string

Unique identifier (UUID) for the waste record

string

Waste identification name

string

Description of the waste

date

Start date of the waste period

date

End date of the waste period

number

Waste quantity in the original unit

number

Adjusted quantity after applying percentage allocation

number

Allocation percentage (0 to 1)

string

Waste destination or treatment facility

number

Distance to waste treatment center in km

string

Current status: uploaded, active, loading, or error

array[string] | null

Error details when status is error

number

CO2 equivalent emissions in kg CO2e

number

Biogenic CO2 emissions in kg CO2e

boolean | null

Whether the waste record is enabled for emission calculations

string | null

UUID of the linked file (if created via bulk import)

string | null

Name of the linked import file

string | null

Download URL for the linked file

datetime

Timestamp when the record was created

datetime | null

Timestamp when the record was last updated

Example

curl -X PATCH "https://api.dcycle.io/v1/wastes/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{
    "base_quantity": 2000.0,
    "description": "Updated municipal solid waste",
    "destination": "New waste treatment plant"
  }'

import requests
import os

api_key = os.getenv("DCYCLE_API_KEY")
org_id = os.getenv("DCYCLE_ORG_ID")
waste_id = "550e8400-e29b-41d4-a716-446655440000"

headers = {
    "x-api-key": api_key,
    "x-organization-id": org_id,
    "Content-Type": "application/json"
}

payload = {
    "base_quantity": 2000.0,
    "description": "Updated municipal solid waste",
    "destination": "New waste treatment plant"
}

response = requests.patch(
    f"https://api.dcycle.io/v1/wastes/{waste_id}",
    headers=headers,
    json=payload
)

waste = response.json()
print(f"Waste updated: {waste['id']}")
print(f"New quantity: {waste['base_quantity']}")

const axios = require('axios');

const apiKey = process.env.DCYCLE_API_KEY;
const orgId = process.env.DCYCLE_ORG_ID;
const wasteId = "550e8400-e29b-41d4-a716-446655440000";

const headers = {
  'x-api-key': apiKey,
  'x-organization-id': orgId,
  'Content-Type': 'application/json'
};

const payload = {
  base_quantity: 2000.0,
  description: "Updated municipal solid waste",
  destination: "New waste treatment plant"
};

axios.patch(
  `https://api.dcycle.io/v1/wastes/${wasteId}`,
  payload,
  { headers }
)
.then(response => {
  const waste = response.data;
  console.log(`Waste updated: ${waste.id}`);
  console.log(`New quantity: ${waste.base_quantity}`);
})
.catch(error => console.error(error));

Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "identification_name": "RSU-2024-001",
  "description": "Updated municipal solid waste",
  "start_date": "2024-01-01",
  "end_date": "2024-03-31",
  "base_quantity": 2000.0,
  "quantity": 2000.0,
  "percentage": 1.0,
  "destination": "New waste treatment plant",
  "total_km_to_waste_center": 25.0,
  "status": "active",
  "error_messages": null,
  "co2e": 601.0,
  "co2e_biomass": 16.4,
  "enabled": true,
  "file_id": null,
  "file_name": null,
  "file_url": null,
  "created_at": "2024-11-24T10:30:00Z",
  "updated_at": "2024-11-24T15:45:00Z"
}

Common Errors

404 Not Found

Cause: Waste record not found in organization

{
  "detail": "Waste with id=UUID('...') not found",
  "code": "WASTE_NOT_FOUND"
}

Solution: Verify the waste ID is correct and belongs to your organization.

403 Forbidden

Cause: Waste doesn’t belong to your organization

{
  "detail": "Waste doesn't belong to organization",
  "code": "FORBIDDEN"
}

Solution: Verify the x-organization-id header matches the organization that owns this waste record.

422 Validation Error

Cause: Invalid values

{
  "detail": [
    {
      "loc": ["body", "base_quantity"],
      "msg": "ensure this value is greater than 0",
      "type": "value_error.number.not_gt"
    }
  ]
}

Solution: Ensure numeric values are valid and within allowed ranges.

List Wastes

Retrieve all waste records

Create Waste

Add a new waste record

Facilities

List facilities for your organization

Create Waste Bulk Delete Wastes

​Update Waste

​Request

​Path Parameters

​Headers

​Body Parameters

​Response

​Example

​Successful Response

​Common Errors

​404 Not Found

​403 Forbidden

​422 Validation Error

​Related Endpoints

List Wastes

Create Waste

Facilities

Update Waste

Request

Path Parameters

Headers

Body Parameters

Response

Example

Successful Response

Common Errors

404 Not Found

403 Forbidden

422 Validation Error

Related Endpoints