Appointments

Update an Appointment.

Changed on

Changes an appointment status, reschedules it, or performs both updates atomically. Rescheduling requires start_time and is only allowed when the resulting status is booked; end_time is optional and, when omitted, the appointment keeps its current duration. Times use the store timezone. The requested timeslot must belong to the product schedule and have available capacity. Changing the status to booked without rescheduling also checks that the appointment's current timeslot still has available capacity. Allowed status transitions: pending to booked or canceled, booked to completed or canceled, and canceled or completed back to booked. To delete an appointment while preserving its order history, set status to canceled.

put/appointments/{id}.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/appointments/{id}.json
  • Auth
    • HTTP basic
    • or API key in query parameter login and API key in query parameter authtoken
    • or OAuth 2
      Authorization code: https://accounts.jumpseller.com/oauth/authorize
      Token URL: https://accounts.jumpseller.com/oauth/token scopes: write_orders

Path parameters

idinteger required

Id of the appointment.

Query parameters

fieldsstring
Example:id,status,timeslot

Comma-separated appointment fields to include in the response.

Request body

Example request

{
  "appointment": {
    "status": "booked",
    "start_time": "2026-08-26 18:49",
    "end_time": "2026-08-26 19:16"
  }
}

Response

Appointment updated successfully.

Changes

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter fields

    • info

      added the optional property to the response with the status

    • info

      endpoint added