---
title: "Appointment Update"
method: POST
path: "/APPOINTMENT_UPDATE"
tags: ["Appointment Scheduling"]
---

# Appointment Update

`POST /APPOINTMENT_UPDATE`

## Request

- Base URL: `https://apidocs.goaugment.com` (the document declares no server; this is the origin it was published from)
- URL: `https://apidocs.goaugment.com/APPOINTMENT_UPDATE`
- Auth: none required
- TypeScript: <https://skmtc.dev/goaugment/apis/webhooks/docs/APPOINTMENT_UPDATE/post.ts> (a function with typed inputs; its response is checked against the schema)

Sent once Augment schedules an appointment with a facility for a stop on a load.

Clients must configure a `PUSH_APPOINTMENT_UPDATE` webhook subscription to receive this event. Ask your Augment contact to set one up.

## Request body

- AppointmentUpdateEvent: Fields present on every v2 webhook event.
  - `id` string, required: Unique event identifier (ULID)
  - `workflow` 'TRACK_AND_TRACE' | 'CARRIER_SUPPORT' | 'POD_COLLECTION' | 'LOAD_BUILDING' | 'CARRIER_SELECTION' | 'SCHEDULING' | 'CUSTOMER_SUPPORT' | 'null', nullable, required: The Augment workflow that produced this event, or `null` when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.
  - `occurredAt` string, date-time, required: When the underlying activity occurred (ISO 8601)
  - `loadNumber` string, nullable, required: Your load reference number
  - `customerLoadInternalId` string, nullable, required: Your internal load ID, if provided during load creation
  - `eventType` 'APPOINTMENT_UPDATE', required: Event name for a stop appointment update.
  - `data` AppointmentUpdateData, required: Contains the stops whose appointments were updated.
    - `route` AppointmentUpdateRouteStop[], required: The stops whose appointment Augment scheduled.
      - `sequence` integer, required: 1-based position of the stop on the load's route.
      - `appointmentConfirmation` AppointmentConfirmation, required: The appointment Augment scheduled with the facility.
        - `start` string, date-time, required: Appointment window start time (UTC ISO 8601).
        - `end` string, date-time, required: Appointment window end time (UTC ISO 8601).
        - `timezone` string, required: IANA timezone of the facility (e.g. `America/Chicago`).
        - `confirmationId` string: Portal/facility confirmation reference.
      - `externalId` string: External ID for the stop (if provided). This is used to link the stop to an external system. Omitted when the stop has no external ID.

## Response `200`

Appointment update received successfully

---

[API](https://skmtc.dev/goaugment/apis/webhooks.md) - [All operations](https://skmtc.dev/goaugment/apis/webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/webhooks/revisions/a074b2ada419?raw)
