Mindbody · Schema

AssignStaffSessionTypeRequest

Implementation of the 'AssignStaffSessionTypeRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
StaffId	integer	The ID of the staff member session type is getting assigned to. The staff member must be assignable to appointments or already be assigned to the session type in the request.
SessionTypeId	integer	The ID of the session type that is getting assigned to the staff member. The session type must be an appointment.
Active	boolean	Indicates if assignment is active. Passing `false` is equivalent to deleting the assignment.
TimeLength	integer	The staff specific amount of time that a session of this type typically lasts.
PrepTime	integer	Prep time in minutes
FinishTime	integer	Finish time in minutes
PayRateType	string	The pay rate type. Can be one of the following (case insensitive): Percent Flat No Pay If PayRateType is not provided in the request and the request is creating a completely new assignment (not editin
PayRateAmount	number	The pay rate amount for the specific staff member. It is parsed according to the PayRateType.

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-assign-staff-session-type-request-schema.json",
  "title": "AssignStaffSessionTypeRequest",
  "description": "Implementation of the 'AssignStaffSessionTypeRequest' model.",
  "type": "object",
  "properties": {
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member session type is getting assigned to. The staff member must be assignable to appointments or already be assigned to the session type in the request.",
      "example": 123456
    },
    "SessionTypeId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the session type that is getting assigned to the staff member. The session type must be an appointment.",
      "example": 123456
    },
    "Active": {
      "type": "boolean",
      "description": "Indicates if assignment is active. Passing `false` is equivalent to deleting the assignment.",
      "example": true
    },
    "TimeLength": {
      "type": "integer",
      "format": "int32",
      "description": "The staff specific amount of time that a session of this type typically lasts.",
      "example": 1
    },
    "PrepTime": {
      "type": "integer",
      "format": "int32",
      "description": "Prep time in minutes",
      "example": 1
    },
    "FinishTime": {
      "type": "integer",
      "format": "int32",
      "description": "Finish time in minutes",
      "example": 1
    },
    "PayRateType": {
      "type": "string",
      "description": "The pay rate type. Can be one of the following (case insensitive): Percent Flat No Pay If PayRateType is not provided in the request and the request is creating a completely new assignment (not editing an existing active or inactive assignment), then the staff member default pay rate and pay rate amount are used to create the assignment. Otherwise, the existing assignment values are used for any optional request parameters not included in the request.",
      "example": "example-value"
    },
    "PayRateAmount": {
      "type": "number",
      "format": "double",
      "description": "The pay rate amount for the specific staff member. It is parsed according to the PayRateType.",
      "example": 49.99
    }
  }
}