Update Facility

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    address: '<string>',
    country: '<string>',
    type: '<string>',
    categories: {},
    cups_list: {},
    status: '<string>',
    logistic_factor: 123
  })
};

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

import requests

url = "https://api.dcycle.io/v1/facilities/{facility_id}"

payload = {
    "name": "<string>",
    "address": "<string>",
    "country": "<string>",
    "type": "<string>",
    "categories": {},
    "cups_list": {},
    "status": "<string>",
    "logistic_factor": 123
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request PUT \
  --url https://api.dcycle.io/v1/facilities/{facility_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "name": "<string>",
  "address": "<string>",
  "country": "<string>",
  "type": "<string>",
  "categories": {},
  "cups_list": {},
  "status": "<string>",
  "logistic_factor": 123
}
'

{
  "id": "<string>",
  "name": "<string>",
  "address": {},
  "country": "<string>",
  "type": "<string>",
  "categories": {},
  "cups_list": {},
  "status": "<string>",
  "co2e": {},
  "co2e_biomass": {},
  "logistic_factor": {},
  "facility_purpose_type": {},
  "created_at": {},
  "updated_at": {},
  "invoices_in_review_count": 123,
  "categories_without_data": 123,
  "water_type": {},
  "methane_burned": {},
  "wwt_line": {
    "id": "<string>",
    "line_code": "<string>"
  },
  "sludge_line": {
    "id": "<string>",
    "line_code": "<string>"
  },
  "wwd_line": {
    "id": "<string>",
    "line_code": "<string>"
  }
}

PUT

facilities

{facility_id}

Update Facility

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    address: '<string>',
    country: '<string>',
    type: '<string>',
    categories: {},
    cups_list: {},
    status: '<string>',
    logistic_factor: 123
  })
};

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

import requests

url = "https://api.dcycle.io/v1/facilities/{facility_id}"

payload = {
    "name": "<string>",
    "address": "<string>",
    "country": "<string>",
    "type": "<string>",
    "categories": {},
    "cups_list": {},
    "status": "<string>",
    "logistic_factor": 123
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request PUT \
  --url https://api.dcycle.io/v1/facilities/{facility_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "name": "<string>",
  "address": "<string>",
  "country": "<string>",
  "type": "<string>",
  "categories": {},
  "cups_list": {},
  "status": "<string>",
  "logistic_factor": 123
}
'

{
  "id": "<string>",
  "name": "<string>",
  "address": {},
  "country": "<string>",
  "type": "<string>",
  "categories": {},
  "cups_list": {},
  "status": "<string>",
  "co2e": {},
  "co2e_biomass": {},
  "logistic_factor": {},
  "facility_purpose_type": {},
  "created_at": {},
  "updated_at": {},
  "invoices_in_review_count": 123,
  "categories_without_data": 123,
  "water_type": {},
  "methane_burned": {},
  "wwt_line": {
    "id": "<string>",
    "line_code": "<string>"
  },
  "sludge_line": {
    "id": "<string>",
    "line_code": "<string>"
  },
  "wwd_line": {
    "id": "<string>",
    "line_code": "<string>"
  }
}

Update Facility

Update an existing facility in your organization. Only include the fields you want to change — all other fields remain unchanged.

Archiving Side Effects: Setting status to archived will also archive any linked logistic hub and deactivate associated supply contracts.

Request

Path Parameters

uuid

required

The UUID of the facility 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 fields are optional — only include what you want to change.

string

Facility name

string

Physical address

string

ISO country code

string

Facility type

array[string]

Consumption categories

array[string]

CUPS codes

string

Status: active or archived

number

Logistic factor (0 to 1)

Response

Returns the updated facility object.

string

Facility UUID

string

Facility name

string | null

Physical address

string

ISO country code

string

Facility type

array[string] | null

Enabled consumption categories

array[string] | null

List of CUPS codes

string

Facility status: active or archived

number | null

Total CO2e emissions (tCO2e)

number | null

CO2e emissions from biomass sources

number | null

Logistic factor for scope 2 (0 to 1)

string | null

Purpose type of the facility

datetime

Creation timestamp (ISO 8601)

string | null

Last update timestamp (ISO 8601)

integer

Number of invoices in review status

integer

Number of configured categories with no invoices

string | null

Water type of the waste water treatment line (only for waste_water_facilities)

boolean | null

Whether methane is burned (only for waste_water_facilities)

object | null

Waste water treatment line config (only for waste_water_facilities)

Show WWT Line Object

string

Line UUID

string

Line code identifier

object | null

Sludge treatment line config (only for waste_water_facilities)

Show Sludge Line Object

string

Line UUID

string

Line code identifier

object | null

Water discharge line config (only for waste_water_facilities)

Show WWD Line Object

string

Line UUID

string

Line code identifier

Example

curl -X PUT "https://api.dcycle.io/v1/facilities/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 '{
    "name": "Madrid HQ",
    "categories": ["heat", "electricity", "water", "recharge"]
  }'

import requests
import os

headers = {
    "x-api-key": os.getenv("DCYCLE_API_KEY"),
    "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    "Content-Type": "application/json"
}

facility_id = "550e8400-e29b-41d4-a716-446655440000"
response = requests.put(
    f"https://api.dcycle.io/v1/facilities/{facility_id}",
    headers=headers,
    json={"name": "Madrid HQ", "categories": ["heat", "electricity", "water", "recharge"]}
)

print(f"Updated: {response.json()['name']}")

const axios = require('axios');

const headers = {
  'x-api-key': process.env.DCYCLE_API_KEY,
  'x-organization-id': process.env.DCYCLE_ORG_ID,
  'Content-Type': 'application/json'
};

const facilityId = '550e8400-e29b-41d4-a716-446655440000';
axios.put(`https://api.dcycle.io/v1/facilities/${facilityId}`, {
  name: "Madrid HQ",
  categories: ["heat", "electricity", "water", "recharge"]
}, { headers })
.then(response => console.log(`Updated: ${response.data.name}`));

Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Madrid HQ",
  "type": "office",
  "country": "ES",
  "address": "Calle Gran Vía 1, Madrid",
  "status": "active",
  "co2e": 1250.5,
  "co2e_biomass": 0.0,
  "logistic_factor": 0.8,
  "categories": ["heat", "electricity", "water", "recharge"],
  "cups_list": ["ES0021000000000001AA"],
  "facility_purpose_type": "facilities",
  "invoices_in_review_count": 0,
  "categories_without_data": 0,
  "water_type": null,
  "methane_burned": null,
  "wwt_line": null,
  "sludge_line": null,
  "wwd_line": null,
  "created_at": "2024-11-24T10:30:00Z",
  "updated_at": "2024-12-01T15:45:00Z"
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: The facility does not exist or belongs to another organization

{"detail": "Facility not found"}

422 Unprocessable Entity

Cause: Invalid field values (e.g. invalid country code or status)

{
  "detail": [
    {
      "loc": ["body", "country"],
      "msg": "Invalid country code",
      "type": "value_error"
    }
  ]
}

Get Facility

Retrieve facility details

Delete Facility

Remove a facility

Create Waste Water Facility Delete Facility

​Update Facility

​Request

​Path Parameters

​Headers

​Body Parameters

​Response

​Example

​Successful Response

​Common Errors

​401 Unauthorized

​403 Forbidden

​404 Not Found

​422 Unprocessable Entity

​Related Endpoints

Get Facility

Delete Facility

Update Facility

Request

Path Parameters

Headers

Body Parameters

Response

Example

Successful Response

Common Errors

401 Unauthorized

403 Forbidden

404 Not Found

422 Unprocessable Entity

Related Endpoints