Update Appointment

PATCH

/public/v1/appointments/{appointment_id}

curl --request PATCH \
  --url https://api.aymaragents.com/public/v1/appointments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "status": "scheduled", "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "notes": "example" }'

• Producción

Partially update an appointment – reschedule/cancel/complete/mark-no-show/notes (SPEC_API_PUBLICA.md §2.4).

Unknown/foreign appointmentId -> 404, zero changes. A reschedule that overlaps -> 409 APPOINTMENT_OVERLAP.

---

Permiso necesario: tenant:appointments.manage

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

appointment_id

required

Appointment Id

string format: uuid

Request Body^required

Media typeapplication/json

PublicUpdateAppointmentRequest

PATCH /public/v1/appointments/{id} body – all fields optional (partial update).

object

status

Any of:

string

string

Allowed values: scheduled cancelled completed no_show

null

null

startsAt

Any of:

string

string format: date-time

null

null

endsAt

Any of:

string

string format: date-time

null

null

notes

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

PublicAppointmentOut

A single appointment, curated subset of the internal AppointmentOut.

Drops googleEventId (CAL-11 internal Google Calendar mirror id, meaningless to a third party) and createdBy (the internal actor id – Platform-only attribution; a public caller already knows who acted, it was its own key).

object

id

required

Id

string

assignedUserId

required

Assigneduserid

string

customerId

Any of:

string

string

null

null

conversationId

Any of:

string

string

null

null

leadId

Any of:

string

string

null

null

title

required

Title

string

appointmentType

required

Appointmenttype

string

startsAt

required

Startsat

string

endsAt

required

Endsat

string

status

required

Status

string

source

required

Source

string

notes

Any of:

string

string

null

null

createdAt

required

Createdat

string

updatedAt

required

Updatedat

string

Example^generated

{
  "id": "example",
  "assignedUserId": "example",
  "customerId": "example",
  "conversationId": "example",
  "leadId": "example",
  "title": "example",
  "appointmentType": "example",
  "startsAt": "example",
  "endsAt": "example",
  "status": "example",
  "source": "example",
  "notes": "example",
  "createdAt": "example",
  "updatedAt": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}