Changes the fields you name in one record. The other fields keep their values. The change is saved in the record’s history under your name.
- Changes data: yes
- Who can use it: Your role’s rights on that object in the “Entities” group of the role: “Update”.
What it is for
- Link a driver or a trailer to a truck. See Fleets.
- Set a location’s working hours. See Locations.
- Change a draft shipment before you publish it. See Freight Procurement.
- Correct a record. See Data models.
Example prompts
- “Set the cargo of shipment TFY000000001 to one item of building materials, 18 t.”
- “Set the working hours of this location to 08:00–20:00.”
Good to know
- A shipment changes only while it is a draft: otherwise “Tender is not in draft status.”
- A link between a truck and its driver or trailer is cleared from the truck: set
driver_idortrailer_idto null. - A shipment’s
cargoandwaypointsare replaced as a whole: send the full list. Leave the field out to keep it.
Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
entity | string | yes | The object, as entities-list names it. |
id | string | yes | The record’s ID. |
fields | object | yes | Only the fields to change. |
reasoning | string | no | Why the record changes. Saved with data model records. |
Returns
The updated record.
Errors
- “Record not found.”
- A refusal for an object that cannot be changed.
- For a data model record: “Validation failed.” with the fields to fix.
- “fields cannot be empty.”
Field "…" is not writable on "…". Writable fields: …- A value outside a field’s list, for example
Invalid value for type_id. - “Truck not found.”, “Driver not found.”, “Trailer not found.” for an ID that does not exist.