Mindbody · JSON Structure

Public Api V6 Add Appointment Add On Request Structure

Implementation of the 'AddAppointmentAddOnRequest' model. Creates an add-on for an appointment

Type: object Properties: 5
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

AddAppointmentAddOnRequest is a JSON Structure definition published by Mindbody, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ApplyPayment AppointmentId SessionTypeId StaffId Test

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-add-appointment-add-on-request-structure.json",
  "name": "AddAppointmentAddOnRequest",
  "description": "Implementation of the 'AddAppointmentAddOnRequest' model. Creates an add-on for an appointment",
  "type": "object",
  "properties": {
    "ApplyPayment": {
      "type": "boolean",
      "description": "When `true`, indicates that a payment should be applied to the appointment. Currently only ApplyPayment=false is implemented. Default: **true**",
      "example": true
    },
    "AppointmentId": {
      "type": "int32",
      "description": "The appointment ID the add-on is getting added to.",
      "example": 123456
    },
    "SessionTypeId": {
      "type": "int32",
      "description": "The session type associated with the new appointment add-on.",
      "example": 123456
    },
    "StaffId": {
      "type": "int32",
      "description": "The ID of the staff member who is adding the new appointment add-on. Default: staff member performing the appointment.",
      "example": 123456
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, indicates that the method is to be validated, but no new appointment add-on data is added. Default: **false**",
      "example": true
    }
  }
}