Update Incident

Purpose

Updates an existing incident in Sodtrack.

The incident is identified by incident (by incidentId or incidentReference). Only the fields you send are updated; omitted fields keep their current values. You can update the description, incident status, accountable user, and dynamic forms data.

Field Definitions

📋 Request body

📝 Dynamic forms

📌 Incident status identifier

👤 User information (accountable)

Example Request (by incident reference)

{
  "incident": {
    "type": "incidentReference",
    "value": "INC-EXT-2025-001"
  },
  "description": "Actualizado: resolución en progreso.",
  "incidentStatus": {
    "type": "statusId",
    "value": "2"
  },
  "accountableUser": {
    "type": "userEmail",
    "value": "manager@example.com"
  }
}

Example Request (by incident ID)

{
  "incident": {
    "type": "incidentId",
    "value": "101"
  },
  "description": "Descripción actualizada del incidente.",
  "incidentStatus": {
    "type": "statusId",
    "value": "3"
  },
  "dynamicForms": [
        {
            "formReference": "incident_status_update_form",
            "values": [
                {
                    "fieldReference": "incident_status_update_form_field_1",
                    "value": "yesterday"
                }
            ]
        }
    ]
}

Example Request (minimal — change status only)

{
  "incident": {
    "type": "incidentId",
    "value": "101"
  },
  "incidentStatus": {
    "type": "statusId",
    "value": "2"
  }
}

Response Example

{
  "id": 101,
  "entityType": "booking",
  "entityId": 12345,
  "bookingId": 12345,
  "incidentStatus": {
    "id": 2,
    "name": "In Progress",
    "description": "In Progress",
    "isFinalStatus": false,
    "isInitialStatus": false,
    "bookingStatusUpdate": ""
  }
}

Response Fields

Error Responses

Business Rules & Constraints

Incident identification

• incident is required, with type and value.

• type must be incidentId or incidentReference. Any other value returns INVALID_INCIDENT_TYPE.

• If no incident is found for the given ID or reference, the API returns INCIDENT_NOT_FOUND.

• When type = incidentReference, if more than one incident matches the reference, the API returns MULTIPLE_INCIDENTS_FOUND_FOR_REFERENCE.

Update behavior

• description, incidentStatus, and accountableUser are optional. Only provided fields are updated; omitted fields leave existing values unchanged.

• You can send only incident plus one or more of description, status, and accountable user.

Accountable user

• When accountableUser is provided, it must resolve to an existing user (by userId, userEmail, or userReference). If the user cannot be resolved, the request fails with INVALID_ACCOUNTABLE_USER.

Incident status

• incidentStatus (when provided) must use type = statusId. statusReference is not yet supported and returns INCIDENT_STATUS_REFERENCE_NOT_SUPPORTED.

• value must be a valid numeric status ID that exists in Sodtrack. Invalid number returns INVALID_INCIDENT_STATUS_ID; non-existent status returns INCIDENT_STATUS_NOT_FOUND.

Data and format

• Dynamic form data (when provided) is validated and stored according to the incident status change flow configuration.

• All timestamps in responses follow ISO 8601 format (UTC) where applicable.