Skip to main content

Action: vehicle_unassign_bookings

Unassign bookings from a vehicle.

action_typestringrequired

Action type identifier.

Constant value: vehicle_unassign_bookings
agent_idsstring<uuid>[]

Unassign all bookings from each specified vehicle.

Default value: []
booking_uidsstring<uuid>[]

List of bookings uids to unassign.

Default value: []
node_grouping_thresholdinteger

Non-negative value defines time interval in seconds which will be used to group upcoming nodes. Negative then grouping is disabled.

Default value: -1
partial_successboolean

If set to true and certain bookings can not be unassigned, e.g. because they contain upcoming nodes, have wrong status, etc then these bookings are skipped and other bookings are inserted. The UIDs of the failed bookings and nodes will be reported in details["rejected_bookings"] and details["rejected_nodes"] of the response object.

Default value: false
Action: vehicle_unassign_bookings
{
"action_type": "string",
"agent_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"booking_uids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"node_grouping_threshold": -1,
"partial_success": false
}