Mindbody · Schema

UpdateAppointmentRequest

Implementation of the 'UpdateAppointmentRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
AppointmentId integer A unique ID for the appointment.
EndDateTime string The end date and time of the new appointment.
Default: **StartDateTime**, offset by the staff member’s default appointment duration.
Execute string The action taken to add this appointment. Possible values are: confirm, unconfirm, arrive, unarrive, cancel, latecancel, complete.
GenderPreference string The client’s service provider gender preference.
Notes string Any general notes about this appointment.
PartnerExternalId string Optional external key for api partners.
ProviderId string If a user has Complementary and Alternative Medicine features enabled, this parameter assigns a provider ID to the appointment.
ResourceIds array A list of resource IDs to associate with the new appointment.
SendEmail boolean 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.
Default: **false**
SessionTypeId integer The session type associated with the new appointment.
StaffId integer The ID of the staff member who is adding the new appointment.
StartDateTime string The start date and time of the new appointment.
ApplyPayment boolean When `true`, appointment will be updated with a current applicable client service from the clients account.
Default: **false**
Test boolean When `true`, indicates that the method is to be validated, but no new appointment data is added.
Default: **false**
View JSON Schema on GitHub

JSON Schema

public-api-v6-update-appointment-request-schema.json Raw ↑ 
{
  "$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-update-appointment-request-schema.json",
  "title": "UpdateAppointmentRequest",
  "description": "Implementation of the 'UpdateAppointmentRequest' model.",
  "type": "object",
  "properties": {
    "AppointmentId": {
      "type": "integer",
      "format": "int32",
      "description": "A unique ID for the appointment.",
      "example": 123456
    },
    "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"
    },
    "Execute": {
      "type": "string",
      "description": "The action taken to add this appointment. Possible values are: confirm, unconfirm, arrive, unarrive, cancel, latecancel, complete.",
      "example": "example-value"
    },
    "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."
    },
    "PartnerExternalId": {
      "type": "string",
      "description": "Optional external key for api partners.",
      "example": "example-value"
    },
    "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
    },
    "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`, appointment will be updated with a current applicable client service from the clients account. <br />Default: **false**",
      "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
    }
  }
}