deleteAppointmentReminder

Delete a reminder by appointmentReminderId. Its scheduled texts stop and it leaves the list and the appointment form; appointments carrying it do not block the delete, their upcoming texts just stop. If it was the default the org has none, unless exactly one reminder remains, which then is. Refused only when something else names its workflow: then pass getDeletionImpact's dependencyResolution (targetKind WORKFLOW_GROUP, targetId = this id). Confirm with the user first: it stops texts their contacts expect.

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": "deleteAppointmentReminder",
    "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.deleteAppointmentReminder(
  {
    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: 'deleteAppointmentReminder',
    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

dependencyResolutionDependencyResolutionInput

impactVersionString!required

replacements[DependencyReplacementSelectionInput!]!required

Every field, all the way down

variables

[
  {
    "name": "appointmentReminderId",
    "type": "ID!",
    "required": true,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "dependencyResolution",
    "type": "DependencyResolutionInput",
    "required": false,
    "description": null,
    "defaultValue": null,
    "fields": [
      {
        "name": "impactVersion",
        "type": "String!",
        "required": true,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "replacements",
        "type": "[DependencyReplacementSelectionInput!]!",
        "required": true,
        "description": null,
        "defaultValue": null,
        "fields": [
          {
            "name": "targetKind",
            "type": "DependencyTargetKind!",
            "required": true,
            "description": null,
            "defaultValue": null,
            "enumValues": [
              "PIPELINE_ITEM",
              "DEAL",
              "PIPELINE_STAGE_PIPELINE_ITEMS",
              "DEAL_STAGE_DEALS",
              "PIPELINE_ITEM_CUSTOM_FIELD",
              "DEAL_CUSTOM_FIELD",
              "PIPELINE_ITEM_CUSTOM_FIELD_OPTION",
              "DEAL_CUSTOM_FIELD_OPTION",
              "PROPERTY_TAG",
              "PROPERTY_LIST",
              "CONTACT_TAG",
              "CONTACT_LIST",
              "CONTACT_CUSTOM_FIELD",
              "CONTACT_CUSTOM_FIELD_OPTION",
              "PIPELINE",
              "DEAL_PIPELINE",
              "PIPELINE_STAGE",
              "DEAL_STAGE",
              "TWILIO_PHONE_NUMBER",
              "EMAIL_IDENTITY",
              "LIBRARY_FOLDER",
              "USER",
              "USER_GROUP",
              "WORKFLOW_GROUP",
              "WORKFLOW_AUTOMATION",
              "CONTENT_TEMPLATE",
              "AGENT",
              "MARKETING_CAMPAIGN",
              "UPLOADED_FILE",
              "WORKFLOW_WEBHOOK_CREDENTIAL",
              "SCRAPER_PIPELINE",
              "FILTER",
              "EMBED_FORM",
              "WORKFLOW_TABLE",
              "WORKFLOW_TABLE_COLUMN",
              "CONTACT",
              "PROPERTY",
              "ORGANIZATION",
              "SLACK_CHANNEL",
              "SLACK_USER",
              "MACHINE_GROUP",
              "MACHINE_HOST"
            ]
          },
          {
            "name": "targetId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "replacementId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          }
        ]
      }
    ]
  }
]

Response

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

response shape

{
  "data": {
    "appointmentReminderMutation": {
      "deleteAppointmentReminder": {
        "id": "<ID>"
      }
    }
  }
}

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