Update Business Travel

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': '<content-type>'
  },
  body: JSON.stringify({
    transport_type: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    distance_km: 123,
    origin: '<string>',
    destination: '<string>',
    name: '<string>',
    email: '<string>',
    travel_type: '<string>',
    travel_number: 123,
    passenger_number: 123,
    vehicle_size: '<string>',
    fuel_type: '<string>',
    renewable_energy: '<string>',
    status: '<string>'
  })
};

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

import requests

url = "https://api.dcycle.io/v1/business-travels/{business_travel_id}"

payload = {
    "transport_type": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "distance_km": 123,
    "origin": "<string>",
    "destination": "<string>",
    "name": "<string>",
    "email": "<string>",
    "travel_type": "<string>",
    "travel_number": 123,
    "passenger_number": 123,
    "vehicle_size": "<string>",
    "fuel_type": "<string>",
    "renewable_energy": "<string>",
    "status": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

curl --request PATCH \
  --url https://api.dcycle.io/v1/business-travels/{business_travel_id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "transport_type": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "distance_km": 123,
  "origin": "<string>",
  "destination": "<string>",
  "name": "<string>",
  "email": "<string>",
  "travel_type": "<string>",
  "travel_number": 123,
  "passenger_number": 123,
  "vehicle_size": "<string>",
  "fuel_type": "<string>",
  "renewable_energy": "<string>",
  "status": "<string>"
}
'

{
  "id": "<string>",
  "organization_id": "<string>",
  "name": {},
  "email": {},
  "transport_type": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "distance_km": {},
  "distance_source": {},
  "origin": {},
  "destination": {},
  "origin_geocode": {},
  "destination_geocode": {},
  "travel_type": "<string>",
  "travel_number": 123,
  "passenger_number": 123,
  "vehicle_size": {},
  "fuel_type": {},
  "renewable_energy": {},
  "status": "<string>",
  "source": "<string>",
  "co2e": {},
  "file_id": {},
  "file_name": {},
  "uploaded_by": {},
  "created_at": {},
  "updated_at": {}
}

PATCH

business-travels

{business_travel_id}

Update Business Travel

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': '<content-type>'
  },
  body: JSON.stringify({
    transport_type: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    distance_km: 123,
    origin: '<string>',
    destination: '<string>',
    name: '<string>',
    email: '<string>',
    travel_type: '<string>',
    travel_number: 123,
    passenger_number: 123,
    vehicle_size: '<string>',
    fuel_type: '<string>',
    renewable_energy: '<string>',
    status: '<string>'
  })
};

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

import requests

url = "https://api.dcycle.io/v1/business-travels/{business_travel_id}"

payload = {
    "transport_type": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "distance_km": 123,
    "origin": "<string>",
    "destination": "<string>",
    "name": "<string>",
    "email": "<string>",
    "travel_type": "<string>",
    "travel_number": 123,
    "passenger_number": 123,
    "vehicle_size": "<string>",
    "fuel_type": "<string>",
    "renewable_energy": "<string>",
    "status": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

curl --request PATCH \
  --url https://api.dcycle.io/v1/business-travels/{business_travel_id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "transport_type": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "distance_km": 123,
  "origin": "<string>",
  "destination": "<string>",
  "name": "<string>",
  "email": "<string>",
  "travel_type": "<string>",
  "travel_number": 123,
  "passenger_number": 123,
  "vehicle_size": "<string>",
  "fuel_type": "<string>",
  "renewable_energy": "<string>",
  "status": "<string>"
}
'

{
  "id": "<string>",
  "organization_id": "<string>",
  "name": {},
  "email": {},
  "transport_type": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "distance_km": {},
  "distance_source": {},
  "origin": {},
  "destination": {},
  "origin_geocode": {},
  "destination_geocode": {},
  "travel_type": "<string>",
  "travel_number": 123,
  "passenger_number": 123,
  "vehicle_size": {},
  "fuel_type": {},
  "renewable_energy": {},
  "status": "<string>",
  "source": "<string>",
  "co2e": {},
  "file_id": {},
  "file_name": {},
  "uploaded_by": {},
  "created_at": {},
  "updated_at": {}
}

Update Business Travel

Update an existing business travel record. Only provide the fields you want to change. Emissions will be recalculated automatically if relevant fields are modified.

Even though all fields are individually optional, you must always provide either distance_km OR both origin and destination in every update request — the distance validation runs on every call.

Request

Headers

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

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

string

required

Must be application/json

Path Parameters

string

required

The unique identifier (UUID) of the business travel recordExample: 550e8400-e29b-41d4-a716-446655440000

Body Parameters

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

string

Mode of transportAvailable values: car, metro, train, trolleybus, bus, motorbike, aircraft, ferry

date

Start date of the business travelFormat: YYYY-MM-DD

date

End date of the business travel. Must be on or after start_dateFormat: YYYY-MM-DD

number

Distance traveled in kilometersConstraints: Must be greater than 0

string

Starting location addressConstraints: Max 500 charactersExample: "Madrid, Spain"

string

Ending location address. Cannot be the same as origin unless distance_km is also provided.Constraints: Max 500 charactersExample: "Barcelona, Spain"

string

Optional label for this travel recordConstraints: Max 255 characters

string

Email of the traveler

string

Whether this is a one-way or round tripAvailable values: one_way, round

integer

Number of tripsConstraints: 1 to 10,000 (further limited by date range — max 100 per day)

integer

Number of passengers per tripConstraints: Must be at least 1

string

Vehicle size. Required when transport_type is car, not allowed for other types.Available values: small, medium, large

string

Fuel type. Required when transport_type is car, not allowed for other types.Available values: diesel, petrol, natural_gas, lpg, electric, hybrid, not_fuel_based, do_not_know

string

Whether the vehicle uses renewable energyAvailable values: yes, no, do_not_know

string

Record statusAvailable values: active, pending, loading, completed, error

Response

Returns the updated business travel object.

string

Unique identifier (UUID)

string

Organization UUID

string | null

Travel record label

string | null

Traveler email

string

Mode of transport

date

Start date of travel

date

End date of travel

number | null

Distance in km

string | null

How the distance was obtained: manual, geodesic, or google_maps

string | null

Starting location address

string | null

Ending location address

object | null

Geocoded origin location resolved from the origin address

Field	Type	Description
`country_code`	string	ISO-2 country code
`place_id`	string	Place identifier
`address_formatted`	string	Full formatted address
`latitude`	number	Latitude coordinate
`longitude`	number	Longitude coordinate

object | null

Geocoded destination location (same structure as origin_geocode)

string

Trip type: one_way or round

integer

Number of trips

integer

Number of passengers per trip

string | null

Vehicle size (car only)

string | null

Fuel type (car only)

string | null

Renewable energy usage

string

Record status: pending, active, error, loading, or completed

string

Record source: api, manual, bulk_upload, or form

number | null

Calculated CO2 equivalent emissions in kg

string | null

File UUID if created via bulk upload

string | null

Name of the source file, if created via bulk upload

object | null

The user who created this record

datetime

Creation timestamp

datetime | null

Last update timestamp

Example

curl -X PATCH "https://api.dcycle.io/v1/business-travels/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 '{
    "travel_number": 3,
    "travel_type": "round",
    "origin": "Madrid, Spain",
    "destination": "Barcelona, Spain"
  }'

import requests
import os

travel_id = "550e8400-e29b-41d4-a716-446655440000"

response = requests.patch(
    f"https://api.dcycle.io/v1/business-travels/{travel_id}",
    headers={
        "x-api-key": os.getenv("DCYCLE_API_KEY"),
        "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    },
    json={
        "travel_number": 3,
        "travel_type": "round",
        "origin": "Madrid, Spain",
        "destination": "Barcelona, Spain",
    },
)

travel = response.json()
print(f"Updated travel: {travel['id']}")
print(f"New emissions: {travel['co2e']} kg CO2e")

const axios = require('axios');

const travelId = '550e8400-e29b-41d4-a716-446655440000';

axios.patch(
  `https://api.dcycle.io/v1/business-travels/${travelId}`,
  {
    travel_number: 3,
    travel_type: 'round',
    origin: 'Madrid, Spain',
    destination: 'Barcelona, Spain',
  },
  {
    headers: {
      'x-api-key': process.env.DCYCLE_API_KEY,
      'x-organization-id': process.env.DCYCLE_ORG_ID,
    },
  }
)
.then(({ data: travel }) => {
  console.log(`Updated travel: ${travel.id}`);
  console.log(`New emissions: ${travel.co2e} kg CO2e`);
})
.catch(error => console.error(error));

Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": null,
  "email": null,
  "transport_type": "train",
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "distance_km": 621.5,
  "distance_source": "google_maps",
  "origin": "Madrid, Spain",
  "destination": "Barcelona, Spain",
  "origin_geocode": null,
  "destination_geocode": null,
  "travel_type": "round",
  "travel_number": 3,
  "passenger_number": 1,
  "vehicle_size": null,
  "fuel_type": null,
  "renewable_energy": null,
  "status": "pending",
  "source": "api",
  "co2e": 24.86,
  "file_id": null,
  "file_name": null,
  "uploaded_by": {
    "id": "user-123",
    "first_name": "Maria",
    "last_name": "García",
    "profile_img_url": null
  },
  "created_at": "2024-12-01T10:30:00Z",
  "updated_at": "2024-12-01T14:45:00Z"
}

When updating fields that affect emissions (distance, transport type, travel number, travel type), the co2e value will be recalculated asynchronously. The status may temporarily change to pending.

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: Business travel not found or doesn’t belong to your organization

{"detail": "BusinessTravel with id=550e8400-e29b-41d4-a716-446655440000 not found", "code": "BUSINESS_TRAVEL_NOT_FOUND"}

422 Unprocessable Entity

Cause: Missing distance — must provide either distance_km OR both origin and destination

{
  "detail": [
    {
      "loc": ["body"],
      "msg": "Either distance_km or origin+destination must be provided",
      "type": "value_error"
    }
  ]
}

Cause: Unknown field sent in request body (this endpoint rejects extra fields)

{
  "detail": [
    {
      "loc": ["body", "round_trip"],
      "msg": "extra fields not permitted",
      "type": "value_error.extra"
    }
  ]
}

Use Cases

Change Route with Distance Recalculation

Update origin and destination to recalculate distance:

response = requests.patch(
    f"https://api.dcycle.io/v1/business-travels/{travel_id}",
    headers=headers,
    json={
        "origin": "Paris, France",
        "destination": "Berlin, Germany",
    },
)

Switch to Round Trip

response = requests.patch(
    f"https://api.dcycle.io/v1/business-travels/{travel_id}",
    headers=headers,
    json={
        "travel_type": "round",
        "origin": "Madrid, Spain",
        "destination": "Barcelona, Spain",
    },
)

Update Car Details

response = requests.patch(
    f"https://api.dcycle.io/v1/business-travels/{travel_id}",
    headers=headers,
    json={
        "vehicle_size": "large",
        "fuel_type": "hybrid",
        "distance_km": 350.0,
    },
)

Get Business Travel

Get current business travel details

Create Business Travel

Create a new business travel record

Delete Business Travel

Remove a business travel record

List Business Travels

Retrieve all business travels

Create Business Travel Delete Business Travel

​Update Business Travel

​Request

​Headers

​Path Parameters

​Body Parameters

​Response

​Example

​Successful Response

​Common Errors

​401 Unauthorized

​403 Forbidden

​404 Not Found

​422 Unprocessable Entity

​Use Cases

​Change Route with Distance Recalculation

​Switch to Round Trip

​Update Car Details

​Related Endpoints

Get Business Travel

Create Business Travel

Delete Business Travel

List Business Travels

Update Business Travel

Request

Headers

Path Parameters

Body Parameters

Response

Example

Successful Response

Common Errors

401 Unauthorized

403 Forbidden

404 Not Found

422 Unprocessable Entity

Use Cases

Change Route with Distance Recalculation

Switch to Round Trip

Update Car Details

Related Endpoints