set_appointment_type_status

This reference is generated from the published tool contract.

Behavior and boundaries

Sets an appointment type to active (its booking page is public and bookable) or paused (back to draft: the page shows it as unavailable, existing bookings stay). This sets a state; it does not toggle one. Activating checks the same things as Ridian: a public name, a connected calendar for bookings, availability and the plan’s limit of active appointment types. Confirm with the user first, especially before activating.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

bookings:write

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "appointment_type_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "appointment_type_id from list_appointment_types."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    }
  },
  "required": [
    "appointment_type_id",
    "status"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "appointment_type": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "console_url": {
      "type": "string"
    }
  },
  "required": [
    "appointment_type",
    "console_url"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling