cancelAppointment

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to PATCH /v1/appointments/{id} in the new API; the migration guide has the recommended order of work and the important model differences.

Two-call migration:

sequenceDiagram
    autonumber
    participant Client
    participant API as Oneserve API
    Client->>API: PATCH /v1/appointments/{id}<br/>{status: CANCELLED}
    API-->>Client: 200 OK (fires appointment-cancelled event)
    Client->>API: POST /v1/jobs/{jobId}/notes<br/>{date, notes: "cancelled by ..."}
    API-->>Client: 201 Created

The acting user (legacy notedId path param) is now implicit from the JWT — record any noted-by context as the note body text on step 2.

Open PATCH /v1/appointments/{id} in the new API →

View legacy reference

/rest/rs/cancelAppointment/{jobRef}/{appointmentRef}

GET

Cancels an appointment.  Looks up the appointment to cancel by the Job Ref and the Appointment Client Ref.

success response representation:

• application/json

{
    "result" : "success",
    "result_msg" : ""
}

error response representation:

• application/json

{
    "result" : "fail",
    "result_msg" : "<Oneserve error code>",
    "result_error_msg" : "<Oneserve error details>"

}

Notes 

See the Resource Scheduler API matrix for the full list of endpoints in this category.