v1

latestOpenAPI 3.1.02026-07-246246106.8 KB

Manage your loads

Update Load Boost

Manually ends an active boost early by setting an unboostedDate. After this call the boost is no longer active.

put/loadmanagement/v2/load/boost

Request body

loadIdstring uuid required

The ID of the load whose boost should be updated.

unboostedDatestring date-time required

The date and time the boost is ended. Sets both boostedTo and unboostedDate.

Example request

{
  "loadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "unboostedDate": "2026-03-03T14:15:00Z"
}

Response

Load boost updated successfully.

idstring uuid

loadIdstring uuid

userIdstring uuid

durationMinutesinteger

Boost duration in minutes. Default is 30.

boostedFromstring date-time

The moment the boost started in UTC.

boostedTostring date-time

The moment the boost ends in UTC.

createdDatestring date-time

updatedDatestring date-time

unboostedDatestring date-time nullable

Set when the boost is manually ended early via update. Null on fresh create.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "loadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "userId": "d4e5f6a7-b8c9-0123-defa-456789012345",
  "durationMinutes": 30,
  "boostedFrom": "2026-03-03T14:00:00Z",
  "boostedTo": "2026-03-03T14:30:00Z",
  "createdDate": "2026-03-03T14:00:00Z",
  "updatedDate": "2026-03-03T14:00:00Z"
}