Updates an existing equipment component record.

PUT/api/v2/equipment/components/{id}

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

idpathinteger · int32required

The ID of the component to update.

Request body

application/jsonrequired

The request containing updated component data.

componentIDinteger · int32
equipmentIDinteger · int32
profileIDinteger · int32
componentLookupIDinteger · int32
componentCategoryIDinteger · int32
componentTypeIDinteger · int32
profileDisplaystringnullable
categorystringnullable
descriptionstringnullable
startDatestring · datenullable
startHoursnumber · double
partNostringnullable
serialNostringnullable
averageLifenumber · double
adjustedLifenumber · double
remainingLifenumber · double
percentUsednumber · double
dueDatestring · date-timenullable
commentsstringnullable
replacedboolean
overdueboolean
replacementIDinteger · int32
componentTypestringnullable
percentUsedDisplaystringnullable

Responses

Component updated successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

componentIdinteger · int32
equipmentIdinteger · int32
componentLookupIdinteger · int32
componentCategoryIdinteger · int32
componentTypeIdinteger · int32
descriptionstring
startDatestring · datenullable
startHoursnumber · double
partNostring
serialNostring
averageLifenumber · double
adjustedLifenumber · double
remainingLifenumber · double
percentUsednumber · double
dueDatestring · datenullable
commentsstring
replacedboolean
deletedboolean

REQUEST EXAMPLE

curl --request PUT \
  'https://apiv2.crmseries.com/api/v2/equipment/components/ID' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "componentID": 1024,
    "equipmentID": 1024,
    "profileID": 1024,
    "componentLookupID": 1024,
    "componentCategoryID": 1024,
    "componentTypeID": 1024,
    "profileDisplay": "string",
    "category": "string",
    "description": "string",
    "startDate": "2026-01-15",
    "startHours": 3250,
    "partNo": "string",
    "serialNo": "CAT0320XABC12345",
    "averageLife": 1.5,
    "adjustedLife": 1.5,
    "remainingLife": 1.5,
    "percentUsed": 1.5,
    "dueDate": "2026-01-15T14:30:00Z",
    "comments": "string",
    "replaced": false,
    "overdue": false,
    "replacementID": 1024,
    "componentType": "string",
    "percentUsedDisplay": "string",
    "availableTypes": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "availableCategories": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ]
  }'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "componentId": 1024,
    "equipmentId": 1024,
    "componentLookupId": 1024,
    "componentCategoryId": 1024,
    "componentTypeId": 1024,
    "description": "string",
    "startDate": "2026-01-15",
    "startHours": 3250,
    "partNo": "string",
    "serialNo": "CAT0320XABC12345",
    "averageLife": 1.5,
    "adjustedLife": 1.5,
    "remainingLife": 1.5,
    "percentUsed": 1.5,
    "dueDate": "2026-01-15",
    "comments": "string",
    "replaced": false,
    "deleted": false
  },
  "errors": []
}