Skip to main content
PATCH
Update an appointment

Authorizations

Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Path Parameters

id
string<uuid>
required

UUID of the appointment to update.

Body

application/json

Partial-update body for PATCH /api/v1/appointments/{id}. Must include at least one updatable field. Setting a nullable field to null clears it. The FK fields (conversation_id, lead_id, offering_id), google_calendar_event_id, and operator-internal notes / assigned_user_id are NOT updatable. Lifecycle-aware webhook emission server-side: changing scheduled_start/scheduled_end emits booking.rescheduled; statuscancelled emits booking.cancelled; statuscompleted emits booking.completed. Time validation (end > start) runs both in-body AND merged-against-existing so a partial PATCH cannot create an inverted window.

customer_name
string
Required string length: 1 - 200
customer_phone
string
Required string length: 5 - 32
customer_email
string<email> | null
scheduled_start
string<date-time>
scheduled_end
string<date-time>
location_text
string | null
Maximum string length: 500
status
enum<string>
Available options:
confirmed,
cancelled,
completed,
rescheduled,
no_show

Response

Appointment updated.

id
string<uuid>
required
customer_name
string
required
customer_phone
string
required
scheduled_start
string<date-time>
required
scheduled_end
string<date-time>
required
status
enum<string>
required
Available options:
confirmed,
cancelled,
completed,
rescheduled,
no_show
created_at
string<date-time>
required
conversation_id
string<uuid> | null
lead_id
string<uuid> | null
offering_id
string<uuid> | null
customer_email
string<email> | null
location_text
string | null
google_calendar_event_id
string | null