Mindbody · Schema

AddStaffAvailabilityRequest

Implementation of the 'AddStaffAvailabilityRequest' model. Add Staff Availability/Unavailability Schedule

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
StaffId	integer	The ID of the staff member that availability or unavailability will be added.
IsAvailability	boolean	When `true`, indicates that availability will be added, When `false`, indicates that unavailability will be added.
DaysOfWeek	array	The days of the week. Must contain at least one of the following Sunday, Monday, Tuesday etc.
StartTime	string	The start time of the schedule. Must be in HH:MM:SS format.
EndTime	string	The end time of the schedule. Must be in HH:MM:SS format.
StartDate	string	The start date of the schedule. Must be in YYYY-MM-DD format.
EndDate	string	The end date of the schedule. Must be in YYYY-MM-DD format.
Description	string	The description of the unavailability, ex. Lunch, Vacation. Required if IsAvailability passed as `false`. Omit if IsAvailability passed as `true`.
ProgramIds	array	A list of program IDs. Must be a valid active schedulable Program ID. Required if IsAvailability passed as `true`. Omit if IsAvailability passed as `false`.
LocationId	integer	The ID of the location where the availability is added. Required if IsAvailability passed as `true`. Omit if IsAvailability passed as `false`.
Status	string	The status of availability or unavailability. Possible values are: * Masked * Hidden * Public Default: Public

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-add-staff-availability-request-schema.json",
  "title": "AddStaffAvailabilityRequest",
  "description": "Implementation of the 'AddStaffAvailabilityRequest' model. Add Staff Availability/Unavailability Schedule",
  "type": "object",
  "properties": {
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member that availability or unavailability will be added.",
      "example": 123456
    },
    "IsAvailability": {
      "type": "boolean",
      "description": "When `true`, indicates that availability will be added, <br /> When `false`, indicates that unavailability will be added.",
      "example": true
    },
    "DaysOfWeek": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The days of the week. Must contain at least one of the following Sunday, Monday, Tuesday etc.",
      "example": [
        "example-value"
      ]
    },
    "StartTime": {
      "type": "string",
      "description": "The start time of the schedule. Must be in HH:MM:SS format.",
      "example": "example-value"
    },
    "EndTime": {
      "type": "string",
      "description": "The end time of the schedule. Must be in HH:MM:SS format.",
      "example": "example-value"
    },
    "StartDate": {
      "type": "string",
      "description": "The start date of the schedule. Must be in YYYY-MM-DD format.",
      "example": "example-value"
    },
    "EndDate": {
      "type": "string",
      "description": "The end date of the schedule. Must be in YYYY-MM-DD format.",
      "example": "example-value"
    },
    "Description": {
      "type": "string",
      "description": "The description of the unavailability, ex. Lunch, Vacation. Required if IsAvailability passed as `false`. Omit if IsAvailability passed as `true`.",
      "example": "Example note for Mindbody Public API."
    },
    "ProgramIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of program IDs. Must be a valid active schedulable Program ID. Required if IsAvailability passed as `true`. Omit if IsAvailability passed as `false`.",
      "example": [
        1
      ]
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where the availability is added. Required if IsAvailability passed as `true`. Omit if IsAvailability passed as `false`.",
      "example": 123456
    },
    "Status": {
      "type": "string",
      "description": "The status of availability or unavailability. Possible values are: * Masked * Hidden * Public Default: Public",
      "example": "Active"
    }
  }
}