Mindbody · Schema

SubstituteClassTeacherRequest

Implementation of the 'SubstituteClassTeacherRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
ClassId	integer	The ID of the class to which a substitute teacher needs to be assigned.
StaffId	integer	The staff ID of the teacher to substitute.
OverrideConflicts	boolean	When `true`, overrides any conflicts in the schedule.
SendClientEmail	boolean	When `true`, sends the client an automatic email about the substitution, if the client has opted to receive email.
SendOriginalTeacherEmail	boolean	When `true`, sends the originally scheduled teacher an automatic email about the substitution.
SendSubstituteTeacherEmail	boolean	When `true`, sends the substituted teacher an automatic email about the substitution.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-substitute-class-teacher-request-schema.json",
  "title": "SubstituteClassTeacherRequest",
  "description": "Implementation of the 'SubstituteClassTeacherRequest' model.",
  "type": "object",
  "properties": {
    "ClassId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the class to which a substitute teacher needs to be assigned.",
      "example": 123456
    },
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The staff ID of the teacher to substitute.",
      "example": 123456
    },
    "OverrideConflicts": {
      "type": "boolean",
      "description": "When `true`, overrides any conflicts in the schedule.",
      "example": true
    },
    "SendClientEmail": {
      "type": "boolean",
      "description": "When `true`, sends the client an automatic email about the substitution, if the client has opted to receive email.",
      "example": true
    },
    "SendOriginalTeacherEmail": {
      "type": "boolean",
      "description": "When `true`, sends the originally scheduled teacher an automatic email about the substitution.",
      "example": true
    },
    "SendSubstituteTeacherEmail": {
      "type": "boolean",
      "description": "When `true`, sends the substituted teacher an automatic email about the substitution.",
      "example": true
    }
  }
}