Skip to content
HeyX API

Record Appointment Result

Required scope: appointment:record_result

Records the visit result for an appointment using a resultCodeId from List Appointment Result Codes. Depending on the code, this may resolve or reopen the linked work order. Agendas that use manual routing do not support recording results this way.

Supply a unique requestId per intended result. The operation is idempotent per requestId: repeating the same requestId returns the original result, while reusing it with different values is rejected.

Generated Reference
POST /public-api/publicapi.v1.Appointment/RecordAppointmentResult

Records a visit result on an appointment and completes it. Idempotent per request_id: replaying the same request_id with identical feedback returns the recorded result; reusing it with different feedback is rejected.

Request RecordAppointmentResultRequest
Response RecordAppointmentResultResponse

RecordAppointmentResultRequest

Field Type Description
appointment_id string Appointment the result is recorded for.
result_code_id string Result code from ListAppointmentResultCodes for the appointment's agenda.
note string Free-text note recorded with the result.
request_id string Idempotency key. Replaying it with identical feedback returns the recorded result; reusing it with different feedback is rejected.

RecordAppointmentResultResponse

Field Type Description
result AppointmentVisitResult The recorded visit result.

Related Types

AppointmentVisitResult

Field Type Description
id string Visit result identifier.
result_code_id string Result code that was selected.
label string Human-readable result label.
solves_work_order bool Whether the selected result resolves the linked work order.
needs_follow_up bool Whether the selected result flags the appointment for follow-up.
note string Free-text note recorded with the result.
state AppointmentVisitResultState Lifecycle state of the recorded result.
selected_at int64 Unix seconds when the result was selected. 
{
  "appointmentId": "<appointment-id>",
  "resultCodeId": "<result-code-id>",
  "note": "Replaced the faulty unit",
  "requestId": "<unique-request-id>"
}
HeyX API