Mindbody · Schema

UpdateClientVisitRequest

Implementation of the 'UpdateClientVisitRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
VisitId	integer	The ID of the visit to be updated.
Makeup	boolean	When `true`, indicates that the visit is eligible to be made up.
SignedIn	boolean	When `true`, indicates that the client has signed in for the visit.
ClientServiceId	integer	The ID of the service to assign to the visit.
Execute	string	The execute code used to update this visit. Possible values are: * Cancel * Latecancel * Unlatecancel
Test	boolean	When `true`, indicates that test mode is enabled. When test mode is enabled, input information is validated, but not committed. Default: false
SendEmail	boolean	When `true`, indicates that the client should be sent an email for cancellations. Note that email is not sent unless the client has an email address and automatic emails have been set up correctly.

View JSON Schema on GitHub

JSON Schema

{
  "$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-client-visit-request-schema.json",
  "title": "UpdateClientVisitRequest",
  "description": "Implementation of the 'UpdateClientVisitRequest' model.",
  "type": "object",
  "properties": {
    "VisitId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the visit to be updated.",
      "example": 123456
    },
    "Makeup": {
      "type": "boolean",
      "description": "When `true`, indicates that the visit is eligible to be made up.",
      "example": true
    },
    "SignedIn": {
      "type": "boolean",
      "description": "When `true`, indicates that the client has signed in for the visit.",
      "example": true
    },
    "ClientServiceId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the service to assign to the visit.",
      "example": 123456
    },
    "Execute": {
      "type": "string",
      "description": "The execute code used to update this visit. Possible values are: * Cancel * Latecancel * Unlatecancel",
      "example": "example-value"
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, indicates that test mode is enabled. When test mode is enabled, 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 for cancellations. Note that email is not sent unless the client has an email address and automatic emails have been set up correctly.<br /> Default: **false**",
      "example": true
    }
  }
}