AddClientToClassVisit

{
  "$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-add-client-to-class-visit-schema.json",
  "title": "AddClientToClassVisit",
  "description": "Implementation of the 'AddClientToClassVisit' model.",
  "type": "object",
  "properties": {
    "AppointmentId": {
      "type": "integer",
      "format": "int32",
      "description": "The appointment\u2019s ID.",
      "example": 123456
    },
    "AppointmentGenderPreference": {
      "$ref": "#/components/schemas/AppointmentGenderPreference1Enum",
      "description": "The gender of staff member with whom the client prefers to book appointments."
    },
    "AppointmentStatus": {
      "$ref": "#/components/schemas/AppointmentStatusEnum",
      "description": "The status of the appointment."
    },
    "ClassId": {
      "type": "integer",
      "format": "int32",
      "description": "The class ID that was used to retrieve the visits.",
      "example": 123456
    },
    "ClientId": {
      "type": "string",
      "description": "The ID of the client associated with the visit.",
      "example": "example-value"
    },
    "StartDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time this class is scheduled to start.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the visit ends. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as \u201c2018-06-25T19:15:00Z\u201d because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the visit.",
      "example": 123456
    },
    "LastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "When included in the request, only records modified on or after the specified `LastModifiedDate` are included in the response. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as \u201c2018-06-25T19:15:00Z\u201d because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ.",
      "example": "2026-05-28T14:30:00Z"
    },
    "LateCancelled": {
      "type": "boolean",
      "description": "When `true`, indicates that the class has been `LateCancelled`.<br /> When `false`, indicates that the class has not been `LateCancelled`.",
      "example": true
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where the visit took place or is to take place.",
      "example": 123456
    },
    "MakeUp": {
      "type": "boolean",
      "description": "When `true`, the client can make up this session and a session is not deducted from the pricing option that was used to sign the client into the enrollment. When the client has the make-up session, a session is automatically removed from a pricing option that matches the service category of the enrollment and is within the same date range of the missed session.<br /> When `false`, the client cannot make up this session. See [Enrollments: Make-ups](https://support.mindbodyonline.com/s/article/203",
      "example": true
    },
    "Name": {
      "type": "string",
      "description": "The name of the class.",
      "example": "Sunset Yoga Studio"
    },
    "ServiceId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the client's pricing option applied to the class visit.",
      "example": 123456
    },
    "ServiceName": {
      "type": "string",
      "description": "The name of the pricing option applied to the class visit.",
      "example": "example-value"
    },
    "ProductId": {
      "type": "integer",
      "format": "int32",
      "description": "The business' ID of the type of pricing option used to pay for the class visit.",
      "example": 123456
    },
    "SignedIn": {
      "type": "boolean",
      "description": "When `true`, indicates that the client has been signed in.<br /> When `false`, indicates that the client has not been signed in.",
      "example": true
    },
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member who is teaching the class.",
      "example": 123456
    },
    "WebSignup": {
      "type": "boolean",
      "description": "When `true`, indicates that the client signed up online.<br /> When `false`, indicates that the client was signed up by a staff member.",
      "example": true
    },
    "Action": {
      "$ref": "#/components/schemas/Action1Enum",
      "description": "The action taken."
    },
    "CrossRegionalBookingPerformed": {
      "type": "boolean",
      "description": "When `true`, indicates that the client is paying for the visit using a pricing option from one of their associated cross-regional profiles.",
      "example": true
    },
    "SiteId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the business from which cross-regional payment is applied.",
      "example": -99
    },
    "WaitlistEntryId": {
      "type": "integer",
      "format": "int32",
      "description": "When this value is not null, it indicates that the client is on the waiting list for the requested class. The only additional fields that are populated when this is not null are: * ClassId * ClientId You can call GET WaitlistEntries using `WaitlistEntryId` to obtain more data about this waiting list entry.",
      "example": 123456
    }
  }
}