GoliathDevelopersGet an API key
Reference/Appointmentsgenerated from the gateway manifest

setDefaultAppointmentReminder

Turn "Run for every appointment" on or off for one reminder.

POST/api/v1/callWRITEidempotent · 24 hruns as the key's owner
View as Markdown

Turn "Run for every appointment" on or off for one reminder (appointmentReminderId), its messages and timing untouched. isGlobal: true makes it the org default and clears any previous one (an org has at most one); false clears it on this one. The org DEFAULT reminder ("Run for every appointment") is attached automatically to booking-page and AI-employee bookings and preselected in the app's appointment form; NOT to appointments created through this API (pass its id as appointmentReminderWorkflowGroupId on createAppointment) nor to existing ones (updateAppointment attaches it). With none flagged and exactly ONE reminder, that one is the default anyway. Confirm with the user before switching it on: from then on every booking texts its contacts this reminder's copy.

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": "setDefaultAppointmentReminder",
    "variables": {
      "appointmentReminderId": "<appointmentReminderId>",
      "isGlobal": true
    }
  }'
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.setDefaultAppointmentReminder(
  {
    appointmentReminderId: '<appointmentReminderId>',
    isGlobal: true
  },
  { 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: 'setDefaultAppointmentReminder',
    variables: {
      appointmentReminderId: '<appointmentReminderId>',
      isGlobal: true
    }
  }),
})
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
isGlobalBoolean!required

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>",
        "isGlobal": true
      }
    }
  }
}

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 →

READlistAppointmentsREADcheckAvailabilityREADlistAppointmentRemindersREADgetMyAvailabilityScheduleWRITEcreateAppointmentWRITEupdateAppointment