EQUIPMENT

Partially updates an equipment

PATCH/api/v2/external/equipment/{id}

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Parameters

idpathinteger · int32required

The ID of the equipment to update.

Request body

application/jsonrequired

The fields and values to update.

updatedFieldsstring[]required
min items 1
pmoemHoursinteger · int32
pmoemExpDatestring · date-timenullable
hoursPerDayOverrideboolean
smrUpdateTypestring
saleDatestring · date-timenullable
carryCostStartDatestring · date-timenullable
calculateCarryCostboolean
inventoryNotesstring
consignmentUnitboolean
baseNostring
acquisitionCostnumber · double
currentCostnumber · double
listPricenumber · double
sellPricenumber · double
satelliteActiveboolean
parentTypestring
parentIDinteger · int32
categoryIDinteger · int32
makestring
modelstring
yearstring
tierstring
serialNostring
equipmentNostring
descriptionstring
activeboolean
stockNostring
inventoryboolean
bookValuenumber · double
currentBranchIDinteger · int32
statusstring
ucTargetWearPercentnumber · double
hoursPerDayRangeinteger · int32
machineboolean
latitudenumber · doublenullable
longitudenumber · doublenullable
startDatestring · date-timenullable
startHoursnumber · doublenullable
hoursPerDaynumber · doublenullable
lastSMRnumber · doublenullable
lastSMRDatestring · date-timenullable
fleetstringnullable
fleetTypestringnullable
newUsedstringnullable
groupCodestringnullable
currentBranchstringnullable
availableForQuotebooleannullable
pmActivebooleannullable
classstringnullable
inOutstringnullable
acquisitionDatestring · date-timenullable

Responses

Equipment successfully updated.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

boolean

REQUEST EXAMPLE

curl --request PATCH \
  'https://apiv2.crmseries.com/api/v2/external/equipment/ID' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedFields": [
      "string"
    ],
    "pmoemHours": 3250,
    "pmoemExpDate": "2026-01-15T14:30:00Z",
    "hoursPerDayOverride": true,
    "smrUpdateType": "string",
    "saleDate": "2026-01-15T14:30:00Z",
    "carryCostStartDate": "2026-01-15T14:30:00Z",
    "calculateCarryCost": true,
    "inventoryNotes": "string",
    "consignmentUnit": true,
    "baseNo": "string",
    "acquisitionCost": 125000.5,
    "currentCost": 125000.5,
    "listPrice": 125000.5,
    "sellPrice": 125000.5,
    "satelliteActive": true,
    "parentType": "string",
    "parentID": 1024,
    "categoryID": 1024,
    "make": "Caterpillar",
    "model": "320",
    "year": "string",
    "tier": "string",
    "serialNo": "CAT0320XABC12345",
    "equipmentNo": "string",
    "description": "string",
    "active": true,
    "stockNo": "STK-1001",
    "inventory": true,
    "bookValue": 125000.5,
    "currentBranchID": 1024,
    "status": "string",
    "ucTargetWearPercent": 1.5,
    "hoursPerDayRange": 3250,
    "machine": true,
    "machineSpecs": [
      {
        "description": "string",
        "salesCode": "string",
        "sequence": 1,
        "cost": 125000.5,
        "list": 1.5
      }
    ],
    "latitude": 41.8781,
    "longitude": -87.6298,
    "startDate": "2026-01-15T14:30:00Z",
    "startHours": 3250,
    "hoursPerDay": 3250,
    "lastSMR": 3250,
    "lastSMRDate": "2026-01-15T14:30:00Z",
    "fleet": "string",
    "fleetType": "string",
    "newUsed": "string",
    "groupCode": "string",
    "currentBranch": "string",
    "availableForQuote": true,
    "pmActive": true,
    "class": "string",
    "inOut": "string",
    "acquisitionDate": "2026-01-15T14:30:00Z",
    "udfs": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ],
    "warranties": [
      {
        "warrantyType": "string",
        "startDate": "2026-01-15T14:30:00Z",
        "endTime": "2026-01-15T14:30:00Z"
      }
    ],
    "replaceSmr": {
      "replaceSmr": 3250,
      "comments": "string"
    }
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": true,
  "errors": []
}