updateAppointmentReminder

A reminder TEXTS REAL CONTACTS automatically. Before calling, show the user every step's exact message and timing and wait for them to confirm that copy; never invent or reword it and send it unseen. Messages may use {{merge fields}} (the APPOINTMENT keys under MERGE FIELDS in updateWorkflowGraph's description); a step with a field an appointment cannot fill is NOT sent for it, so keep to fields every appointment has. Edit a reminder by appointmentReminderId (listAppointmentReminders). steps REPLACES the whole set: send every step to keep, with its message and timing. A step left out stops sending (booked appointments included), a kept step's scheduled texts take the edit, and a NEW step reaches only appointments booked after the edit. isGlobal: omit to leave the default untouched, true to make this the default, false to stop it being one. Only the default: setDefaultAppointmentReminder.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "updateAppointmentReminder",
    "variables": {
      "appointmentReminderId": "<appointmentReminderId>"
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.appointments.updateAppointmentReminder(
  {
    appointmentReminderId: '<appointmentReminderId>'
  },
  { idempotencyKey: crypto.randomUUID() },
)

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'updateAppointmentReminder',
    variables: {
      appointmentReminderId: '<appointmentReminderId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

appointmentReminderIdID!required

steps[AppointmentReminderStepInput!]

One step of a reminder: a single SMS and how far ahead of the appointment's `startDate` to send it.

messageString!required

amountBeforeInt!required

unitBeforeAppointmentReminderTimeUnit!required

Unit for `AppointmentReminder.amountBefore`. Capped at DAYS: a reminder more than a day before the appointment isn't a meaningful product use case.

MINUTESHOURSDAYS

isGlobalBoolean

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "appointmentReminderMutation": {
      "updateAppointmentReminder": {
        "id": "<ID>",
        "steps": [
          {
            "message": "…",
            "amountBefore": 0,
            "unitBefore": "MINUTES"
          }
        ],
        "isGlobal": true,
        "updatedAt": "2026-01-01T00:00:00.000Z"
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

Variables

Response

Errors

Idempotency

Related