Vantax AIDocs
PATCH

Update Appointment

Updates one or more fields on an existing appointment.

PATCHhttps://api.vantaxai.com/v1/appointments/{appointment_id}

Only include the fields you want to change. Reschedule by sending a new `appointment_date`, or move the booking by sending a new `calendar_id`. Changing `status` is how you confirm, complete, or cancel an appointment. Updates are synced to the connected external calendar when one is configured.

Headers

  • Authorizationstringrequired

    Bearer authentication with your secret API key.

    example: Bearer vx_live_3fa9c2…

  • Content-Typestringrequired

    Must be application/json for requests with a body.

    example: application/json

Path Parameters

  • appointment_idstringrequired

    The appointment to update.

    example: appt_7c1d90

Body Parameters

  • calendar_idstringoptional

    Move the appointment to a different calendar.

  • titlestringoptional

    New title.

  • descriptionstringoptional

    Updated notes.

  • appointment_datestringoptional

    Reschedule to a new ISO-8601 UTC start time.

    example: 2026-06-09T16:30:00Z

  • durationintegeroptional

    New length in minutes.

  • statusstringoptional

    Update the appointment status.

    scheduledconfirmedcompletedcancelledno_show

    example: completed

  • locationstringoptional

    New location.

Request

curl -X PATCH https://api.vantaxai.com/v1/appointments/appt_7c1d90 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{ "status": "completed" }'

Response

{
  "success": true,
  "message": "Appointment updated successfully",
  "data": {
    "id": "appt_7c1d90",
    "contact_id": "ct_4f8a21",
    "calendar_id": "cal_22f9",
    "agent_id": "agt_3d9b21",
    "title": "Dental cleaning consultation",
    "appointment_date": "2026-06-09T15:00:00Z",
    "duration": 30,
    "status": "completed",
    "location": "Downtown Clinic, Suite 200",
    "updated_at": "2026-06-09T15:32:00Z"
  }
}