Mindbody · JSON Structure

Public Api V6 Add Client To Enrollment Request Structure

Implementation of the 'AddClientToEnrollmentRequest' model. Add Client To Enrollment Request Model

Type: object Properties: 8
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

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

Properties

ClientId ClassScheduleId EnrollDateForward EnrollOpen Test SendEmail Waitlist WaitlistEntryId

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-client-to-enrollment-request-structure.json",
  "name": "AddClientToEnrollmentRequest",
  "description": "Implementation of the 'AddClientToEnrollmentRequest' model. Add Client To Enrollment Request Model",
  "type": "object",
  "properties": {
    "ClientId": {
      "type": "string",
      "description": "The client IDs of the clients to add to the specified enrollments.",
      "example": "example-value"
    },
    "ClassScheduleId": {
      "type": "int32",
      "description": "The class schedule IDs of the enrollments to add the clients to. The ClassScheduleId can be found in GetEnrollments as the EnrollmentId.",
      "example": 123456
    },
    "EnrollDateForward": {
      "type": "datetime",
      "description": "Enroll the clients from this date forward. `EnrollDateForward` takes priority over open enrollment. Default: **null**",
      "example": "2026-05-28T14:30:00Z"
    },
    "EnrollOpen": {
      "type": "array",
      "items": {
        "type": "datetime"
      },
      "description": "Enroll for selected dates.",
      "example": [
        "2026-05-28T14:30:00Z"
      ]
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, input information is validated, but not committed.<br /> Default: **false**",
      "example": true
    },
    "SendEmail": {
      "type": "boolean",
      "description": "When `true`, indicates that the client should be sent an email. An email is only sent if the client has an email address and automatic emails have been set up. <br /> Default: **false**",
      "example": true
    },
    "Waitlist": {
      "type": "boolean",
      "description": "When `true`, the client is added to a specific enrollments waiting list. Default: **false**",
      "example": true
    },
    "WaitlistEntryId": {
      "type": "int32",
      "description": "The waiting list entry to add. Used to add a client to an enrollment from a waiting list entry.",
      "example": 123456
    }
  }
}