AddAppointmentRequest

{
  "$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-appointment-request-schema.json",
  "title": "AddAppointmentRequest",
  "description": "Implementation of the 'AddAppointmentRequest' model. Represents a request to add a new appointment, including details such as client information, appointment timing, location, and additional preferences.",
  "type": "object",
  "properties": {
    "ClientId": {
      "type": "string",
      "description": "The RRSID of the client for whom the new appointment is being made.",
      "example": "example-value"
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where the new appointment is to take place.",
      "example": 123456
    },
    "SessionTypeId": {
      "type": "integer",
      "format": "int32",
      "description": "The session type associated with the new appointment.",
      "example": 123456
    },
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member who is adding the new appointment.",
      "example": 123456
    },
    "StartDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The start date and time of the new appointment.",
      "example": "2026-05-28T14:30:00Z"
    },
    "ApplyPayment": {
      "type": "boolean",
      "description": "When `true`, indicates that a payment should be applied to the appointment. <br />Default: **true**",
      "example": true
    },
    "Duration": {
      "type": "integer",
      "format": "int32",
      "description": "The duration of the appointment. This parameter is used to change the default duration of an appointment.",
      "example": 1
    },
    "EndDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The end date and time of the new appointment. <br /> Default: **StartDateTime**, offset by the staff member\u2019s default appointment duration.",
      "example": "2026-05-28T14:30:00Z"
    },
    "GenderPreference": {
      "type": "string",
      "description": "The client\u2019s service provider gender preference.",
      "example": "example-value"
    },
    "Notes": {
      "type": "string",
      "description": "Any general notes about this appointment.",
      "example": "Example note for Mindbody Public API."
    },
    "ProviderId": {
      "type": "string",
      "description": "If a user has Complementary and Alternative Medicine features enabled, this parameter assigns a provider ID to the appointment.",
      "example": "example-value"
    },
    "ResourceIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of resource IDs to associate with the new appointment.",
      "example": [
        1
      ]
    },
    "SendEmail": {
      "type": "boolean",
      "description": "Whether to send client an email for cancellations. An email is sent only if the client has an email address and automatic emails have been set up. <br />Default: **false**",
      "example": true
    },
    "StaffRequested": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member was requested specifically by the client.",
      "example": true
    },
    "Test": {
      "type": "boolean",
      "description": "When true, indicates that the method is to be validated, but no new appointment data is added. <br />Default: **false**",
      "example": true
    },
    "IsWaitlist": {
      "type": "boolean",
      "description": "When `true`, indicates that the client should be added to a specific appointment waiting list. When `false`, the client should not be added to the waiting list. Default: **false**",
      "example": true
    },
    "IsRequest": {
      "type": "boolean",
      "description": "Indicates whether to add an appointment request for review. If `true`, the appointment will be added as a request, bypassing the `IsWaitlist` parameter and two validations: 1. If a consumer is adding the appointment for another person. 2. If a staff member without permission to add appointments for other staff members is adding the appointment for another staff member. This also allows anonymous calls (without an authentication token) to this endpoint. The `AllowClientsToBookAppointments` option",
      "example": true
    },
    "PartnerExternalId": {
      "type": "string",
      "description": "Optional external key for api partners.",
      "example": "example-value"
    },
    "AddAppointmentRequestId": {
      "type": "integer",
      "format": "int32",
      "description": "A unique identifier for tracking the AddAppointmentRequest. This ID is not stored and is used to match each request with its corresponding response. The request object will also be returned in the response, with the same ID value. - For single requests, this value will be ignored. - For multiple requests, if no value is provided, the system will generate an identifier ranging from 0 to (number of requests - 1).",
      "example": 123456
    }
  }
}