{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-remove-clients-from-classes-request-structure.json",
"name": "RemoveClientsFromClassesRequest",
"description": "Implementation of the 'RemoveClientsFromClassesRequest' model. Remove Clients From Classes Request",
"type": "object",
"properties": {
"Details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassClientDetail"
},
"description": "This object includes `ClientIds`: List of the RSSID(string) of the clients to remove from the specified class. `ClassId`: The ID(number) of the class that you want to remove the clients from.",
"example": [
{}
]
},
"Test": {
"type": "boolean",
"description": "When `true`, the request ensures that its parameters are valid without affecting real data.
When `false`, the request performs as intended and may affect live client data.
Default: **false**",
"example": true
},
"SendEmail": {
"type": "boolean",
"description": "When `true`, indicates that the client should be sent an email. Depending on the site and client settings, an email may or may not be sent.
Default: **false** **Note**: When the Authorization header is passed and the SendEmail is set to `true`, then an email will be sent. When the Authorization header is passed and the SendEmail is set to `false`, then an email will not be sent. When the Authorization header is not passed and the SendEmail is set to either `true` or `false`, then an email ",
"example": true
},
"LateCancel": {
"type": "boolean",
"description": "When `true`, indicates that the client is to be late cancelled from the class.
When `false`, indicates that the client is to be early cancelled from the class.
Default: **false**",
"example": true
},
"Limit": {
"type": "int32",
"description": "Number of results to include, defaults to 100",
"example": 10
},
"Offset": {
"type": "int32",
"description": "Page offset, defaults to 0.",
"example": 10
}
}
}